diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 1d752c43e..0ef5494f9 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -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." @@ -3212,12 +3216,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -3263,98 +3261,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", @@ -3456,6 +3362,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": { "type": [ "string", @@ -3857,6 +3773,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", @@ -3958,6 +4204,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": { "type": [ "string", @@ -7303,10 +7559,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" ], @@ -7958,6 +8329,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -7976,6 +8354,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": [ @@ -8028,17 +8411,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": [ { @@ -8063,14 +8446,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" } } } @@ -8085,17 +8468,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": [ { @@ -8394,6 +9052,13 @@ "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", + "null" + ] } } }, @@ -12816,6 +13481,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", @@ -13289,7 +14025,10 @@ }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", - "type": "array", + "type": [ + "array", + "null" + ], "minItems": 1, "items": { "type": "object", @@ -13323,8 +14062,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -16474,12 +17224,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -23109,17 +23853,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } }, @@ -23297,17 +24045,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -44473,16 +45225,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).\"", @@ -44498,12 +45240,6 @@ }, { "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -61643,7 +62379,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" ], @@ -75284,17 +76020,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -75463,17 +76203,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -76022,7 +76766,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" ], @@ -102393,6 +103137,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.", @@ -102590,6 +103342,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": { @@ -105754,661 +106515,188 @@ ], "additionalProperties": false }, - "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", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "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.", + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", "type": "object", "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/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" + "id": { + "type": "integer", + "format": "int64" }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + "name": { + "type": "string" }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] + "description": { + "type": "string" }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" + "slug": { + "type": "string" }, - "commit_sha": { + "url": { "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] + "format": "uri" }, - "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": { + "sync_to_organizations": { "type": "string", - "description": "The file path of the wiki page", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", "examples": [ - "/example/Home.md" + "disabled | all" ] }, - "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": { + "organization_selection_type": { "type": "string", - "description": "SHA-1 hash ID of the associated blob", "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" + "disabled | selected | all" ] }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", + "group_id": { + "type": [ + "string", + "null" + ], "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + "62ab9291-fae2-468e-974b-7e45096d5021" ] }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", + "group_name": { + "type": [ + "string", + "null" + ], + "description": "Retired: this field will not be returned with GHEC enterprise teams.", "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + "Justice League" ] }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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": { + "html_url": { "type": "string", "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", "examples": [ - "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.", - "examples": [ - "https://github.com/community/community/discussions/39082" + "https://github.com/enterprises/dc/teams/justice-league" ] - } - }, - "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": { + }, + "members_url": { + "type": "string" + }, + "created_at": { "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "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": { + "format": "date-time" + }, + "updated_at": { "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] + "format": "date-time" } }, "required": [ - "discussion_comment_url" + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at", + "group_id" ] }, - "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.", + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "pull_request_title_url": { + "login": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + "github" ] - } - }, - "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.", + }, + "id": { + "type": "integer", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + 1 ] - } - }, - "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": { + }, + "node_id": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] - } - }, - "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": { + }, + "url": { "type": "string", "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + "https://api.github.com/orgs/github" ] - } - }, - "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": { + }, + "repos_url": { "type": "string", "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - }, - "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" - } - ] - }, - "organization-secret-scanning-alert": { - "type": "object", - "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/alert-updated-at" - } + "https://api.github.com/orgs/github/repos" ] }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { + "events_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", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } + "examples": [ + "https://api.github.com/orgs/github/events" ] }, - "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": { + "hooks_url": { "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "$ref": "#/components/schemas/simple-repository" - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "push_protection_bypass_request_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } + "examples": [ + "https://api.github.com/orgs/github/hooks" ] }, - "push_protection_bypass_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when reviewing a push protection bypass." - }, - "push_protection_bypass_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when requesting a push protection bypass." - }, - "push_protection_bypass_request_html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment that was optionally added when this alert was closed" - }, - "validity": { + "issues_url": { "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the secret was publicly leaked." - }, - "multi_repo": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." - }, - "is_base64_encoded": { - "type": [ - "boolean", - "null" - ], - "description": "A boolean value representing whether or not alert is base64 encoded" - }, - "first_location_detected": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/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": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } + "examples": [ + "https://api.github.com/orgs/github/issues" ] - } - } - }, - "enterprise-team": { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { + "members_url": { "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", "examples": [ - "disabled | all" + "https://api.github.com/orgs/github/members{/member}" ] }, - "organization_selection_type": { + "public_members_url": { "type": "string", "examples": [ - "disabled | selected | all" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "group_id": { - "type": [ - "string", - "null" - ], + "avatar_url": { + "type": "string", "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" + "https://github.com/images/error/octocat_happy.gif" ] }, - "group_name": { + "description": { "type": [ "string", "null" ], - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "examples": [ - "Justice League" - ] - }, - "html_url": { - "type": "string", - "format": "uri", "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" + "A great organization" ] - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" } }, "required": [ - "id", + "login", "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at", - "group_id" + "public_members_url", + "avatar_url", + "description" ] }, "actor": { @@ -110613,105 +110901,6 @@ "subscribed" ] }, - "organization-simple": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -110748,6 +110937,40 @@ }, "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "required": [ + "property_name", + "value" + ] + }, "billing-premium-request-usage-report-org": { "type": "object", "properties": { @@ -110813,7 +111036,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -110821,7 +111044,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -110829,7 +111052,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -111522,6 +111745,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -111692,6 +111922,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -111704,6 +111938,128 @@ "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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", @@ -112449,6 +112805,15 @@ "closed" ] }, + "campaign-alert-type": { + "title": "Campaign alert type", + "description": "Indicates the alert type of a campaign", + "type": "string", + "enum": [ + "code_scanning", + "secret_scanning" + ] + }, "team-simple": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", @@ -117390,40 +117755,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", - "type": [ - "null", - "string", - "array" - ] - } - }, - "required": [ - "property_name", - "value" - ] - }, "org-repo-custom-property-values": { "title": "Organization Repository Custom Property Values", "description": "List of custom property values for a repository", @@ -119923,6 +120254,578 @@ } ] }, + "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", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + null + ] + }, + "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", + "examples": [ + "/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", + "examples": [ + "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", + "examples": [ + "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", + "examples": [ + "/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", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + }, + "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" + } + ] + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/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", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/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", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment that was optionally added when this alert was closed" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." + }, + "is_base64_encoded": { + "type": [ + "boolean", + "null" + ], + "description": "A boolean value representing whether or not alert is base64 encoded" + }, + "first_location_detected": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/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": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + } + } + }, "secret-scanning-row-version": { "type": [ "string", @@ -140006,7 +140909,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -140014,7 +140917,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -140022,7 +140925,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -288819,192 +289722,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": [ { @@ -289067,6 +289784,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": [ { @@ -290587,24 +291338,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", @@ -290683,6 +291416,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": { @@ -290908,6 +291675,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", @@ -291971,6 +292777,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ @@ -296857,6 +297675,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", @@ -308305,40 +309309,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", @@ -318019,113 +318989,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.", @@ -318144,6 +319007,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.", @@ -318288,15 +319160,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.", @@ -318369,6 +319232,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.", @@ -318966,6 +319848,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.", @@ -318984,6 +319911,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-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 5a3328d6f..88f6cc877 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -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 @@ -2302,8 +2304,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': @@ -2331,61 +2331,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 @@ -2459,6 +2404,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: type: - string @@ -2706,6 +2663,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 @@ -2781,6 +2941,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: type: - string @@ -5136,12 +5308,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 @@ -5701,6 +5968,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -5718,6 +5991,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 @@ -5749,6 +6027,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 @@ -6005,6 +6474,12 @@ 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 + - 'null' examples: default: value: @@ -9221,6 +9696,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 @@ -9563,7 +10085,9 @@ paths: format: uri code_scanning_alerts: description: The code scanning alerts to include in this campaign - type: array + type: + - array + - 'null' minItems: 1 items: type: object @@ -9590,7 +10114,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -11974,8 +12502,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': @@ -16692,17 +17218,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 - examples: - - 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" @@ -16814,17 +17342,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -32333,14 +32863,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)." @@ -32351,8 +32873,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 @@ -44635,6 +45155,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 @@ -54458,17 +54981,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54576,17 +55101,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54950,7 +55477,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 @@ -73832,6 +74362,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 @@ -74008,6 +74545,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 @@ -76466,424 +77011,6 @@ components: - fixed_at - repository additionalProperties: false - 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 - - 'null' - description: "**Required when the `state` is `resolved`.** The reason for resolving - the alert." - 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 - examples: - - "/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 - examples: - - 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 - examples: - - 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 - examples: - - "/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 - examples: - - af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki page - examples: - - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - examples: - - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki commit - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url - 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" - organization-secret-scanning-alert: - type: object - properties: - number: - "$ref": "#/components/schemas/alert-number" - created_at: - "$ref": "#/components/schemas/alert-created-at" - updated_at: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/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 - - 'null' - format: date-time - description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - resolved_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/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 - - 'null' - description: Whether push protection was bypassed for the detected secret. - push_protection_bypassed_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - push_protection_bypassed_at: - type: - - string - - 'null' - format: date-time - description: 'The time that push protection was bypassed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - push_protection_bypass_request_reviewer: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - push_protection_bypass_request_reviewer_comment: - type: - - string - - 'null' - description: An optional comment when reviewing a push protection bypass. - push_protection_bypass_request_comment: - type: - - string - - 'null' - description: An optional comment when requesting a push protection bypass. - push_protection_bypass_request_html_url: - type: - - string - - 'null' - format: uri - description: The URL to a push protection bypass request. - resolution_comment: - type: - - string - - 'null' - description: The comment that was optionally added when this alert was closed - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: - - boolean - - 'null' - description: Whether the secret was publicly leaked. - multi_repo: - type: - - boolean - - 'null' - description: Whether the detected secret was found in multiple repositories - in the same organization or enterprise. - is_base64_encoded: - type: - - boolean - - 'null' - description: A boolean value representing whether or not alert is base64 - encoded - first_location_detected: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/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: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -76948,6 +77075,77 @@ components: - created_at - updated_at - group_id + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + 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 @@ -79957,239 +80155,190 @@ components: - reason - url - subscribed - organization-simple: - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - examples: - - github - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github - repos_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/events - hooks_url: - type: string - examples: - - https://api.github.com/orgs/github/hooks - issues_url: - type: string - examples: - - https://api.github.com/orgs/github/issues - members_url: - type: string - examples: - - https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - examples: - - https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - examples: - - https://github.com/images/error/octocat_happy.gif - description: - type: - - string - - 'null' - examples: - - A great organization - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - dependabot-repository-access-details: - title: Dependabot Repository Access Details - description: Information about repositories that Dependabot is able to access - in an organization - type: object - properties: - default_level: - type: - - string - - 'null' - description: The default repository access level for Dependabot updates. - enum: - - public - - internal - - - examples: - - internal - accessible_repositories: - type: array - items: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-repository" - additionalProperties: false - billing-premium-request-usage-report-org: - type: object - properties: - timePeriod: - type: object - properties: - year: - type: integer - description: The year for the usage report. - month: - type: integer - description: The month for the usage report. - day: - type: integer - description: The day for the usage report. - required: - - year - organization: - type: string - description: The unique identifier of the organization. - user: - type: string - description: The name of the user for the usage report. - product: - type: string - description: The product for the usage report. - model: - type: string - description: The model for the usage report. - usageItems: - type: array - items: - type: object - properties: - product: - type: string - description: Product name. - sku: - type: string - description: SKU name. - model: - type: string - description: Model name. - unitType: - type: string - description: Unit type of the usage line item. - pricePerUnit: - type: number - description: Price per unit of the usage line item. - grossQuantity: - type: integer - description: Gross quantity of the usage line item. - grossAmount: - type: number - description: Gross amount of the usage line item. - discountQuantity: - type: integer - description: Discount quantity of the usage line item. - discountAmount: - type: number - description: Discount amount of the usage line item. - netQuantity: - type: integer - description: Net quantity of the usage line item. - netAmount: - type: number - description: Net amount of the usage line item. - required: - - product - - sku - - model - - unitType - - pricePerUnit - - grossQuantity - - grossAmount - - discountQuantity - - discountAmount - - netQuantity - - netAmount - required: - - timePeriod - - organization - - usageItems - billing-usage-report: - type: object - properties: - usageItems: - type: array - items: - type: object - properties: - date: - type: string - description: Date of the usage line item. - product: - type: string - description: Product name. - sku: - type: string - description: SKU name. - quantity: - type: integer - description: Quantity of the usage line item. - unitType: - type: string - description: Unit type of the usage line item. - pricePerUnit: - type: number - description: Price per unit of the usage line item. - grossAmount: - type: number - description: Gross amount of the usage line item. - discountAmount: - type: number - description: Discount amount of the usage line item. - netAmount: - type: number - description: Net amount of the usage line item. - organizationName: - type: string - description: Name of the organization. - repositoryName: - type: string - description: Name of the repository. - required: - - date - - product - - sku - - quantity - - unitType - - pricePerUnit - - grossAmount - - discountAmount - - netAmount - - organizationName - organization-full: - title: Organization Full - description: Organization Full + dependabot-repository-access-details: + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able to access + in an organization + type: object + properties: + default_level: + type: + - string + - 'null' + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + - + examples: + - internal + accessible_repositories: + type: array + items: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + type: + - 'null' + - string + - array + required: + - property_name + - value + billing-premium-request-usage-report-org: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + organization: + type: string + description: The unique identifier of the organization. + user: + type: string + description: The name of the user for the usage report. + product: + type: string + description: The product for the usage report. + model: + type: string + description: The model for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + model: + type: string + description: Model name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - model + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - organization + - usageItems + billing-usage-report: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + organizationName: + type: string + description: Name of the organization. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount + - organizationName + organization-full: + title: Organization Full + description: Organization Full type: object properties: login: @@ -80647,6 +80796,11 @@ components: - github - partner - custom + version: + description: The image version of the hosted runner pool. + type: string + examples: + - latest required: - id - size_gb @@ -80771,6 +80925,9 @@ components: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -80779,6 +80936,97 @@ 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 + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + examples: + - 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 + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - 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 @@ -81357,6 +81605,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 team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified @@ -85089,28 +85344,6 @@ components: - org_actors 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 - type: - - 'null' - - string - - array - required: - - property_name - - value org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository @@ -86946,6 +87179,424 @@ components: state: type: object description: The state of the ruleset version + 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 + - 'null' + description: "**Required when the `state` is `resolved`.** The reason for resolving + the alert." + 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 + examples: + - "/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 + examples: + - 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 + examples: + - 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 + examples: + - "/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 + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + examples: + - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + examples: + - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + 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" + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + resolution_comment: + type: + - string + - 'null' + description: The comment that was optionally added when this alert was closed + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple repositories + in the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert is base64 + encoded + first_location_detected: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" secret-scanning-row-version: type: - string @@ -101269,19 +101920,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 @@ -212583,181 +213234,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 @@ -212810,6 +213286,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' @@ -214185,20 +214689,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 @@ -214271,6 +214761,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: @@ -214452,6 +214959,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 @@ -215296,6 +215831,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: @@ -219518,6 +220059,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 @@ -229287,23 +230003,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 @@ -237798,109 +238497,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 @@ -237916,6 +238512,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. @@ -238037,13 +238640,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 @@ -238110,6 +238706,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. @@ -238622,6 +239233,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). @@ -238640,6 +239293,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-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 1d752c43e..0ef5494f9 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/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." @@ -3212,12 +3216,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -3263,98 +3261,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", @@ -3456,6 +3362,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": { "type": [ "string", @@ -3857,6 +3773,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", @@ -3958,6 +4204,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": { "type": [ "string", @@ -7303,10 +7559,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" ], @@ -7958,6 +8329,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -7976,6 +8354,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": [ @@ -8028,17 +8411,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": [ { @@ -8063,14 +8446,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" } } } @@ -8085,17 +8468,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": [ { @@ -8394,6 +9052,13 @@ "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", + "null" + ] } } }, @@ -12816,6 +13481,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", @@ -13289,7 +14025,10 @@ }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", - "type": "array", + "type": [ + "array", + "null" + ], "minItems": 1, "items": { "type": "object", @@ -13323,8 +14062,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -16474,12 +17224,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -23109,17 +23853,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } }, @@ -23297,17 +24045,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -44473,16 +45225,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).\"", @@ -44498,12 +45240,6 @@ }, { "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -61643,7 +62379,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" ], @@ -75284,17 +76020,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -75463,17 +76203,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -76022,7 +76766,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" ], @@ -102393,6 +103137,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.", @@ -102590,6 +103342,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": { @@ -105754,661 +106515,188 @@ ], "additionalProperties": false }, - "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", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "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.", + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", "type": "object", "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/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" + "id": { + "type": "integer", + "format": "int64" }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + "name": { + "type": "string" }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] + "description": { + "type": "string" }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" + "slug": { + "type": "string" }, - "commit_sha": { + "url": { "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] + "format": "uri" }, - "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": { + "sync_to_organizations": { "type": "string", - "description": "The file path of the wiki page", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", "examples": [ - "/example/Home.md" + "disabled | all" ] }, - "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": { + "organization_selection_type": { "type": "string", - "description": "SHA-1 hash ID of the associated blob", "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" + "disabled | selected | all" ] }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", + "group_id": { + "type": [ + "string", + "null" + ], "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + "62ab9291-fae2-468e-974b-7e45096d5021" ] }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", + "group_name": { + "type": [ + "string", + "null" + ], + "description": "Retired: this field will not be returned with GHEC enterprise teams.", "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + "Justice League" ] }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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": { + "html_url": { "type": "string", "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", "examples": [ - "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.", - "examples": [ - "https://github.com/community/community/discussions/39082" + "https://github.com/enterprises/dc/teams/justice-league" ] - } - }, - "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": { + }, + "members_url": { + "type": "string" + }, + "created_at": { "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "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": { + "format": "date-time" + }, + "updated_at": { "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] + "format": "date-time" } }, "required": [ - "discussion_comment_url" + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at", + "group_id" ] }, - "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.", + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "pull_request_title_url": { + "login": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + "github" ] - } - }, - "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.", + }, + "id": { + "type": "integer", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + 1 ] - } - }, - "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": { + }, + "node_id": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] - } - }, - "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": { + }, + "url": { "type": "string", "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + "https://api.github.com/orgs/github" ] - } - }, - "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": { + }, + "repos_url": { "type": "string", "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - }, - "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" - } - ] - }, - "organization-secret-scanning-alert": { - "type": "object", - "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/alert-updated-at" - } + "https://api.github.com/orgs/github/repos" ] }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { + "events_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", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } + "examples": [ + "https://api.github.com/orgs/github/events" ] }, - "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": { + "hooks_url": { "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "$ref": "#/components/schemas/simple-repository" - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "push_protection_bypass_request_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } + "examples": [ + "https://api.github.com/orgs/github/hooks" ] }, - "push_protection_bypass_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when reviewing a push protection bypass." - }, - "push_protection_bypass_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when requesting a push protection bypass." - }, - "push_protection_bypass_request_html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment that was optionally added when this alert was closed" - }, - "validity": { + "issues_url": { "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the secret was publicly leaked." - }, - "multi_repo": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." - }, - "is_base64_encoded": { - "type": [ - "boolean", - "null" - ], - "description": "A boolean value representing whether or not alert is base64 encoded" - }, - "first_location_detected": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/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": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } + "examples": [ + "https://api.github.com/orgs/github/issues" ] - } - } - }, - "enterprise-team": { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { + "members_url": { "type": "string", - "description": "Retired: this field will not be returned with GHEC enterprise teams.", "examples": [ - "disabled | all" + "https://api.github.com/orgs/github/members{/member}" ] }, - "organization_selection_type": { + "public_members_url": { "type": "string", "examples": [ - "disabled | selected | all" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "group_id": { - "type": [ - "string", - "null" - ], + "avatar_url": { + "type": "string", "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" + "https://github.com/images/error/octocat_happy.gif" ] }, - "group_name": { + "description": { "type": [ "string", "null" ], - "description": "Retired: this field will not be returned with GHEC enterprise teams.", - "examples": [ - "Justice League" - ] - }, - "html_url": { - "type": "string", - "format": "uri", "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" + "A great organization" ] - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" } }, "required": [ - "id", + "login", "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at", - "group_id" + "public_members_url", + "avatar_url", + "description" ] }, "actor": { @@ -110613,105 +110901,6 @@ "subscribed" ] }, - "organization-simple": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -110748,6 +110937,40 @@ }, "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "required": [ + "property_name", + "value" + ] + }, "billing-premium-request-usage-report-org": { "type": "object", "properties": { @@ -110813,7 +111036,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -110821,7 +111044,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -110829,7 +111052,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -111522,6 +111745,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -111692,6 +111922,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -111704,6 +111938,128 @@ "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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", @@ -112449,6 +112805,15 @@ "closed" ] }, + "campaign-alert-type": { + "title": "Campaign alert type", + "description": "Indicates the alert type of a campaign", + "type": "string", + "enum": [ + "code_scanning", + "secret_scanning" + ] + }, "team-simple": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", @@ -117390,40 +117755,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", - "type": [ - "null", - "string", - "array" - ] - } - }, - "required": [ - "property_name", - "value" - ] - }, "org-repo-custom-property-values": { "title": "Organization Repository Custom Property Values", "description": "List of custom property values for a repository", @@ -119923,6 +120254,578 @@ } ] }, + "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", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + null + ] + }, + "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", + "examples": [ + "/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", + "examples": [ + "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", + "examples": [ + "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", + "examples": [ + "/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", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "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.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + }, + "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" + } + ] + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/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", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/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", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment that was optionally added when this alert was closed" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." + }, + "is_base64_encoded": { + "type": [ + "boolean", + "null" + ], + "description": "A boolean value representing whether or not alert is base64 encoded" + }, + "first_location_detected": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/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": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + } + } + }, "secret-scanning-row-version": { "type": [ "string", @@ -140006,7 +140909,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -140014,7 +140917,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -140022,7 +140925,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -288819,192 +289722,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": [ { @@ -289067,6 +289784,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": [ { @@ -290587,24 +291338,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", @@ -290683,6 +291416,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": { @@ -290908,6 +291675,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", @@ -291971,6 +292777,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ @@ -296857,6 +297675,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", @@ -308305,40 +309309,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", @@ -318019,113 +318989,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.", @@ -318144,6 +319007,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.", @@ -318288,15 +319160,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.", @@ -318369,6 +319232,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.", @@ -318966,6 +319848,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.", @@ -318984,6 +319911,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-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 5a3328d6f..88f6cc877 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/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 @@ -2302,8 +2304,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': @@ -2331,61 +2331,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 @@ -2459,6 +2404,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: type: - string @@ -2706,6 +2663,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 @@ -2781,6 +2941,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: type: - string @@ -5136,12 +5308,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 @@ -5701,6 +5968,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -5718,6 +5991,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 @@ -5749,6 +6027,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 @@ -6005,6 +6474,12 @@ 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 + - 'null' examples: default: value: @@ -9221,6 +9696,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 @@ -9563,7 +10085,9 @@ paths: format: uri code_scanning_alerts: description: The code scanning alerts to include in this campaign - type: array + type: + - array + - 'null' minItems: 1 items: type: object @@ -9590,7 +10114,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -11974,8 +12502,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': @@ -16692,17 +17218,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 - examples: - - 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" @@ -16814,17 +17342,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -32333,14 +32863,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)." @@ -32351,8 +32873,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 @@ -44635,6 +45155,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 @@ -54458,17 +54981,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54576,17 +55101,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -54950,7 +55477,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 @@ -73832,6 +74362,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 @@ -74008,6 +74545,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 @@ -76466,424 +77011,6 @@ components: - fixed_at - repository additionalProperties: false - 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 - - 'null' - description: "**Required when the `state` is `resolved`.** The reason for resolving - the alert." - 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 - examples: - - "/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 - examples: - - 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 - examples: - - 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 - examples: - - "/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 - examples: - - af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki page - examples: - - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - examples: - - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki commit - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url - 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" - organization-secret-scanning-alert: - type: object - properties: - number: - "$ref": "#/components/schemas/alert-number" - created_at: - "$ref": "#/components/schemas/alert-created-at" - updated_at: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/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 - - 'null' - format: date-time - description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - resolved_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/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 - - 'null' - description: Whether push protection was bypassed for the detected secret. - push_protection_bypassed_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - push_protection_bypassed_at: - type: - - string - - 'null' - format: date-time - description: 'The time that push protection was bypassed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - push_protection_bypass_request_reviewer: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - push_protection_bypass_request_reviewer_comment: - type: - - string - - 'null' - description: An optional comment when reviewing a push protection bypass. - push_protection_bypass_request_comment: - type: - - string - - 'null' - description: An optional comment when requesting a push protection bypass. - push_protection_bypass_request_html_url: - type: - - string - - 'null' - format: uri - description: The URL to a push protection bypass request. - resolution_comment: - type: - - string - - 'null' - description: The comment that was optionally added when this alert was closed - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: - - boolean - - 'null' - description: Whether the secret was publicly leaked. - multi_repo: - type: - - boolean - - 'null' - description: Whether the detected secret was found in multiple repositories - in the same organization or enterprise. - is_base64_encoded: - type: - - boolean - - 'null' - description: A boolean value representing whether or not alert is base64 - encoded - first_location_detected: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/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: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -76948,6 +77075,77 @@ components: - created_at - updated_at - group_id + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + 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 @@ -79957,239 +80155,190 @@ components: - reason - url - subscribed - organization-simple: - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - examples: - - github - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github - repos_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/events - hooks_url: - type: string - examples: - - https://api.github.com/orgs/github/hooks - issues_url: - type: string - examples: - - https://api.github.com/orgs/github/issues - members_url: - type: string - examples: - - https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - examples: - - https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - examples: - - https://github.com/images/error/octocat_happy.gif - description: - type: - - string - - 'null' - examples: - - A great organization - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - dependabot-repository-access-details: - title: Dependabot Repository Access Details - description: Information about repositories that Dependabot is able to access - in an organization - type: object - properties: - default_level: - type: - - string - - 'null' - description: The default repository access level for Dependabot updates. - enum: - - public - - internal - - - examples: - - internal - accessible_repositories: - type: array - items: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-repository" - additionalProperties: false - billing-premium-request-usage-report-org: - type: object - properties: - timePeriod: - type: object - properties: - year: - type: integer - description: The year for the usage report. - month: - type: integer - description: The month for the usage report. - day: - type: integer - description: The day for the usage report. - required: - - year - organization: - type: string - description: The unique identifier of the organization. - user: - type: string - description: The name of the user for the usage report. - product: - type: string - description: The product for the usage report. - model: - type: string - description: The model for the usage report. - usageItems: - type: array - items: - type: object - properties: - product: - type: string - description: Product name. - sku: - type: string - description: SKU name. - model: - type: string - description: Model name. - unitType: - type: string - description: Unit type of the usage line item. - pricePerUnit: - type: number - description: Price per unit of the usage line item. - grossQuantity: - type: integer - description: Gross quantity of the usage line item. - grossAmount: - type: number - description: Gross amount of the usage line item. - discountQuantity: - type: integer - description: Discount quantity of the usage line item. - discountAmount: - type: number - description: Discount amount of the usage line item. - netQuantity: - type: integer - description: Net quantity of the usage line item. - netAmount: - type: number - description: Net amount of the usage line item. - required: - - product - - sku - - model - - unitType - - pricePerUnit - - grossQuantity - - grossAmount - - discountQuantity - - discountAmount - - netQuantity - - netAmount - required: - - timePeriod - - organization - - usageItems - billing-usage-report: - type: object - properties: - usageItems: - type: array - items: - type: object - properties: - date: - type: string - description: Date of the usage line item. - product: - type: string - description: Product name. - sku: - type: string - description: SKU name. - quantity: - type: integer - description: Quantity of the usage line item. - unitType: - type: string - description: Unit type of the usage line item. - pricePerUnit: - type: number - description: Price per unit of the usage line item. - grossAmount: - type: number - description: Gross amount of the usage line item. - discountAmount: - type: number - description: Discount amount of the usage line item. - netAmount: - type: number - description: Net amount of the usage line item. - organizationName: - type: string - description: Name of the organization. - repositoryName: - type: string - description: Name of the repository. - required: - - date - - product - - sku - - quantity - - unitType - - pricePerUnit - - grossAmount - - discountAmount - - netAmount - - organizationName - organization-full: - title: Organization Full - description: Organization Full + dependabot-repository-access-details: + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able to access + in an organization + type: object + properties: + default_level: + type: + - string + - 'null' + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + - + examples: + - internal + accessible_repositories: + type: array + items: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + type: + - 'null' + - string + - array + required: + - property_name + - value + billing-premium-request-usage-report-org: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + organization: + type: string + description: The unique identifier of the organization. + user: + type: string + description: The name of the user for the usage report. + product: + type: string + description: The product for the usage report. + model: + type: string + description: The model for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + model: + type: string + description: Model name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - model + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - organization + - usageItems + billing-usage-report: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + organizationName: + type: string + description: Name of the organization. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount + - organizationName + organization-full: + title: Organization Full + description: Organization Full type: object properties: login: @@ -80647,6 +80796,11 @@ components: - github - partner - custom + version: + description: The image version of the hosted runner pool. + type: string + examples: + - latest required: - id - size_gb @@ -80771,6 +80925,9 @@ components: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -80779,6 +80936,97 @@ 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 + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + examples: + - 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 + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - 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 @@ -81357,6 +81605,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 team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified @@ -85089,28 +85344,6 @@ components: - org_actors 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 - type: - - 'null' - - string - - array - required: - - property_name - - value org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository @@ -86946,6 +87179,424 @@ components: state: type: object description: The state of the ruleset version + 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 + - 'null' + description: "**Required when the `state` is `resolved`.** The reason for resolving + the alert." + 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 + examples: + - "/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 + examples: + - 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 + examples: + - 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 + examples: + - "/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 + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + examples: + - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + examples: + - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + 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" + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + resolution_comment: + type: + - string + - 'null' + description: The comment that was optionally added when this alert was closed + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple repositories + in the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert is base64 + encoded + first_location_detected: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" secret-scanning-row-version: type: - string @@ -101269,19 +101920,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 @@ -212583,181 +213234,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 @@ -212810,6 +213286,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' @@ -214185,20 +214689,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 @@ -214271,6 +214761,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: @@ -214452,6 +214959,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 @@ -215296,6 +215831,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: @@ -219518,6 +220059,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 @@ -229287,23 +230003,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 @@ -237798,109 +238497,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 @@ -237916,6 +238512,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. @@ -238037,13 +238640,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 @@ -238110,6 +238706,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. @@ -238622,6 +239233,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). @@ -238640,6 +239293,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 4fd58eb26..2a440794f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -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." @@ -5607,6 +5611,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.", @@ -5804,6 +5816,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": { @@ -6698,6 +6719,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.", @@ -6895,6 +6924,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": { @@ -7562,6 +7600,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.", @@ -7759,6 +7805,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": { @@ -7991,6 +8046,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.", @@ -8188,6 +8251,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": { @@ -10278,6 +10350,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.", @@ -10475,6 +10555,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": { @@ -11401,6 +11490,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.", @@ -11598,6 +11695,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": { @@ -12388,6 +12494,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.", @@ -12585,6 +12699,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": { @@ -13078,6 +13201,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.", @@ -13275,6 +13406,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": { @@ -22616,29 +22756,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).\"", @@ -24471,2163 +24588,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": { - "anyOf": [ - { - "type": "null" - }, - { - "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": { - "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", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "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" - ] - } - ] - }, - "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", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "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", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "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", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "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" - ] - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "push_protection_bypass_request_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "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" - ] - } - ] - }, - "push_protection_bypass_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when reviewing a push protection bypass." - }, - "push_protection_bypass_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when requesting a push protection bypass." - }, - "push_protection_bypass_request_html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment that was optionally added when this alert was closed" - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the secret was publicly leaked." - }, - "multi_repo": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." - }, - "is_base64_encoded": { - "type": [ - "boolean", - "null" - ], - "description": "A boolean value representing whether or not alert is base64 encoded" - }, - "first_location_detected": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - "/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", - "examples": [ - "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", - "examples": [ - "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", - "examples": [ - "/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", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - ] - }, - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "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" - ] - } - ] - } - } - } - }, - "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", @@ -26874,6 +24834,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": { "type": [ "string", @@ -28424,6 +26394,876 @@ } } }, + "/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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", @@ -28670,6 +27510,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": { "type": [ "string", @@ -76361,10 +75211,391 @@ } } }, + "/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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" ], @@ -76508,7 +75739,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -76516,7 +75747,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -76524,7 +75755,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -79074,6 +78305,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -79204,6 +78442,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -79344,6 +78586,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -79362,6 +78611,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": [ @@ -79459,6 +78713,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -79589,6 +78850,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -79644,6 +78909,639 @@ } } }, + "/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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", @@ -80238,6 +80136,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -80368,6 +80273,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -80483,6 +80392,13 @@ "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", + "null" + ] } } }, @@ -80569,6 +80485,309 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "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", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "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, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + 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", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + }, + "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", + "examples": [ + 5 + ] + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 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", + "examples": [ + "latest" + ] } }, "required": [ @@ -80699,291 +80918,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] - } - }, - "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", - "examples": [ - 5 - ] }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "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", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "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, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "image_gen": { "type": "boolean", - "examples": [ - 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", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -86971,6 +86909,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -87101,6 +87046,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -97158,6 +97107,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", @@ -98836,7 +98889,10 @@ }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", - "type": "array", + "type": [ + "array", + "null" + ], "minItems": 1, "items": { "type": "object", @@ -98870,8 +98926,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -115170,29 +115237,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).\"", @@ -135763,6 +135807,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.", @@ -135960,6 +136012,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": { @@ -136869,6 +136930,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.", @@ -137066,6 +137135,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": { @@ -171836,17 +171914,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } }, @@ -180822,17 +180904,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -353327,16 +353413,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).\"", @@ -353364,29 +353440,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": { @@ -395615,6 +395668,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.", @@ -395812,6 +395873,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": { @@ -577049,7 +577119,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" ], @@ -658103,6 +658173,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.", @@ -658300,6 +658378,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": { @@ -731001,6 +731088,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.", @@ -731198,6 +731293,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": { @@ -739040,17 +739144,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -747999,17 +748107,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -776666,7 +776778,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" ], @@ -776797,7 +776909,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -776805,7 +776917,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -776813,7 +776925,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -946024,6 +946136,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.", @@ -946221,6 +946341,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": { @@ -949090,6 +949219,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.", @@ -949287,6 +949424,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": { @@ -952061,6 +952207,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.", @@ -952258,6 +952412,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": { @@ -955032,6 +955195,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.", @@ -955229,6 +955400,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": { @@ -958137,6 +958317,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.", @@ -958334,6 +958522,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": { @@ -961249,6 +961446,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.", @@ -961446,6 +961651,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": { @@ -966356,6 +966570,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.", @@ -966553,6 +966775,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 0aad05175..f1d93bcbd 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -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 @@ -905,7 +907,7 @@ paths: - subscriptions_url - type - url - type: &292 + type: &287 type: string description: The type of credit the user is receiving. enum: @@ -1038,7 +1040,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &106 + schema: &105 title: Validation Error Simple description: Validation Error Simple type: object @@ -1071,7 +1073,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &605 + - &610 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1656,7 +1658,7 @@ paths: schema: type: integer default: 30 - - &177 + - &183 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 @@ -1672,7 +1674,7 @@ paths: application/json: schema: type: array - items: &178 + items: &184 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1768,7 +1770,7 @@ paths: - installation_id - repository_id examples: - default: &179 + default: &185 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1831,7 +1833,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &105 + schema: &104 title: Validation Error description: Validation Error type: object @@ -1903,7 +1905,7 @@ paths: description: Response content: application/json: - schema: &180 + schema: &186 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2038,7 +2040,7 @@ paths: - request - response examples: - default: &181 + default: &187 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2242,7 +2244,7 @@ paths: parameters: - *17 - *19 - - &75 + - &72 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) @@ -2495,6 +2497,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 @@ -2675,6 +2685,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 @@ -2792,7 +2811,7 @@ paths: suspended_at: suspended_by: headers: - Link: &57 + Link: &52 example: ; rel="next", ; rel="last" schema: @@ -2982,7 +3001,7 @@ paths: - selected repositories: type: array - items: &66 + items: &64 title: Repository description: A repository on GitHub. type: object @@ -3009,7 +3028,7 @@ paths: license: anyOf: - type: 'null' - - &71 + - &69 title: License Simple description: License Simple type: object @@ -5387,7 +5406,7 @@ paths: responses: '202': *37 '422': *7 - '500': &100 + '500': &98 description: Internal Error content: application/json: @@ -7717,7 +7736,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &152 + code_scanning_options: &161 type: - object - 'null' @@ -7915,7 +7934,7 @@ paths: description: Response content: application/json: - schema: &154 + schema: &163 type: array description: A list of default code security configurations items: @@ -7931,7 +7950,7 @@ paths: default configuration: *41 examples: - default: &155 + default: &164 value: - default_for_new_repos: public configuration: @@ -8262,7 +8281,7 @@ paths: - *40 - *43 responses: - '204': &156 + '204': &165 description: A header with no content is returned. '400': *14 '403': *27 @@ -8389,7 +8408,7 @@ paths: default: value: default_for_new_repos: all - configuration: &153 + configuration: &162 value: id: 1325 target_type: organization @@ -8474,7 +8493,7 @@ paths: application/json: schema: type: array - items: &157 + items: &166 type: object description: Repositories associated with a code security configuration and attachment status @@ -8819,7 +8838,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &158 + repository: &167 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8913,7 +8932,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &162 + - &170 name: state in: query description: |- @@ -8922,7 +8941,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &163 + - &171 name: severity in: query description: |- @@ -8931,7 +8950,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &164 + - &172 name: ecosystem in: query description: |- @@ -8940,14 +8959,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &165 + - &173 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 - - &166 + - &174 name: epss_percentage in: query description: |- @@ -8959,7 +8978,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 - - &458 + - &453 name: has in: query description: |- @@ -8973,7 +8992,7 @@ paths: type: string enum: - patch - - &167 + - &175 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8983,7 +9002,7 @@ paths: enum: - development - runtime - - &168 + - &176 name: sort in: query description: |- @@ -9001,31 +9020,6 @@ paths: - *46 - *38 - *39 - - &169 - 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 - - &170 - 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': @@ -9034,11 +9028,11 @@ paths: application/json: schema: type: array - items: &171 + items: &177 type: object description: A Dependabot alert. properties: - number: &52 + number: &151 type: integer description: The security alert number. readOnly: true @@ -9104,7 +9098,7 @@ paths: - direct - transitive - - security_advisory: &459 + security_advisory: &454 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9311,29 +9305,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *50 - url: &55 + url: &154 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &56 + html_url: &155 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &53 + created_at: &152 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: &54 + updated_at: &153 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: &148 + dismissed_at: &157 type: - string - 'null' @@ -9364,7 +9358,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &147 + fixed_at: &156 type: - string - 'null' @@ -9372,7 +9366,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &460 + auto_dismissed_at: &455 type: - string - 'null' @@ -9399,7 +9393,7 @@ paths: - repository additionalProperties: false examples: - default: &172 + default: &178 value: - number: 2 state: dismissed @@ -9727,740 +9721,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: - - *40 - - &280 - 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 - - &281 - 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 - - &282 - 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 - - &283 - 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 - - *46 - - *17 - - *38 - - *39 - - &284 - 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 - - &285 - 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 - - &286 - 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 - - &287 - 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: &288 - type: object - properties: - number: *52 - created_at: *53 - updated_at: - anyOf: - - type: 'null' - - *54 - url: *55 - html_url: *56 - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this - alert. - state: &583 - 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: &584 - type: - - string - - 'null' - description: "**Required when the `state` is `resolved`.** The - reason for resolving the alert." - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - - - resolved_at: - type: - - string - - 'null' - format: date-time - description: 'The time that the alert was resolved in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - resolved_by: - anyOf: - - type: 'null' - - *4 - 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: *51 - push_protection_bypassed: - type: - - boolean - - 'null' - description: Whether push protection was bypassed for the detected - secret. - push_protection_bypassed_by: - anyOf: - - type: 'null' - - *4 - push_protection_bypassed_at: - type: - - string - - 'null' - format: date-time - description: 'The time that push protection was bypassed in - ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - push_protection_bypass_request_reviewer: - anyOf: - - type: 'null' - - *4 - push_protection_bypass_request_reviewer_comment: - type: - - string - - 'null' - description: An optional comment when reviewing a push protection - bypass. - push_protection_bypass_request_comment: - type: - - string - - 'null' - description: An optional comment when requesting a push protection - bypass. - push_protection_bypass_request_html_url: - type: - - string - - 'null' - format: uri - description: The URL to a push protection bypass request. - resolution_comment: - type: - - string - - 'null' - description: The comment that was optionally added when this - alert was closed - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: - - boolean - - 'null' - description: Whether the secret was publicly leaked. - multi_repo: - type: - - boolean - - 'null' - description: Whether the detected secret was found in multiple - repositories in the same organization or enterprise. - is_base64_encoded: - type: - - boolean - - 'null' - description: A boolean value representing whether or not alert - is base64 encoded - first_location_detected: - anyOf: - - type: 'null' - - &585 - description: 'Details on the location where the token was - initially detected. This can be a commit, wiki commit, issue, - discussion, pull request. - - ' - oneOf: - - &587 - 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 - examples: - - "/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 - examples: - - 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 - examples: - - 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 - - &588 - 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 - examples: - - "/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 - examples: - - af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki - page - examples: - - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - examples: - - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki - commit - examples: - - 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 - - &589 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - - &590 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - - &591 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - - &592 - 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. - examples: - - https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - - &593 - 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. - examples: - - https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - - &594 - 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. - examples: - - https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - - &595 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - - &596 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - - &597 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - - &598 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - - &599 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url - 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: - anyOf: - - type: 'null' - - *4 - examples: - default: &289 - 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: *57 - '404': *6 - '503': &73 - 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 @@ -10482,7 +9742,7 @@ paths: application/json: schema: type: array - items: &58 + items: &53 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -10547,7 +9807,7 @@ paths: - updated_at - group_id examples: - default: &59 + default: &54 value: - id: 1 name: Justice League @@ -10560,7 +9820,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *57 + Link: *52 '403': *27 x-github: githubCloudOnly: false @@ -10604,6 +9864,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: type: - string @@ -10623,9 +9895,9 @@ paths: description: Response content: application/json: - schema: *58 + schema: *53 examples: - default: *59 + default: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10643,7 +9915,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *40 - - &60 + - &55 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -10662,7 +9934,7 @@ paths: type: array items: *4 examples: - default: &61 + default: &56 value: - login: octocat id: 1 @@ -10683,7 +9955,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10701,7 +9973,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *40 - - *60 + - *55 requestBody: required: true content: @@ -10732,7 +10004,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10750,7 +10022,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *40 - - *60 + - *55 requestBody: required: true content: @@ -10781,7 +10053,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10799,8 +10071,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *40 - - *60 - - &62 + - *55 + - &57 name: username description: The handle for the GitHub user account. in: path @@ -10814,7 +10086,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &63 + exampleKey1: &58 value: login: octocat id: 1 @@ -10850,8 +10122,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *40 - - *60 - - *62 + - *55 + - *57 responses: '201': description: Successfully added team member @@ -10859,7 +10131,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *63 + exampleKey1: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10877,8 +10149,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *40 - - *60 - - *62 + - *55 + - *57 responses: '204': description: Response @@ -10888,6 +10160,303 @@ 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: + - *40 + - *55 + - *17 + - *19 + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: &59 + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + examples: + default: &60 + 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: + - *40 + - *55 + 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: *59 + examples: + default: &96 + 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: + - *40 + - *55 + 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: + - *40 + - *55 + - &61 + 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: *59 + examples: + default: *60 + '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: + - *40 + - *55 + - *61 + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: *59 + examples: + default: *60 + 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: + - *40 + - *55 + - *61 + 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 @@ -10903,7 +10472,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *40 - - &64 + - &62 name: team_slug description: The slug of the team name. in: path @@ -10915,11 +10484,11 @@ paths: description: Response content: application/json: - schema: *58 + schema: *53 examples: - default: *59 + default: *54 headers: - Link: *57 + Link: *52 '403': *27 x-github: githubCloudOnly: false @@ -10937,7 +10506,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *40 - - *64 + - *62 requestBody: required: true content: @@ -10965,6 +10534,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: type: - string @@ -10983,11 +10564,11 @@ paths: description: Response content: application/json: - schema: *58 + schema: *53 examples: - default: *59 + default: *54 headers: - Link: *57 + Link: *52 '403': *27 x-github: githubCloudOnly: false @@ -11008,7 +10589,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *40 - - *64 + - *62 responses: '204': description: Response @@ -11046,7 +10627,7 @@ paths: application/json: schema: type: array - items: &94 + items: &91 title: Event description: Event type: object @@ -11057,7 +10638,7 @@ paths: type: - string - 'null' - actor: &65 + actor: &63 title: Actor description: Actor type: object @@ -11098,7 +10679,7 @@ paths: - id - name - url - org: *65 + org: *63 payload: oneOf: - title: CreateEvent @@ -11145,7 +10726,7 @@ paths: properties: action: type: string - discussion: &699 + discussion: &703 title: Discussion description: A Discussion in a repository. type: object @@ -11442,7 +11023,7 @@ paths: - id labels: type: array - items: &67 + items: &65 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -11525,7 +11106,7 @@ paths: properties: action: type: string - issue: &68 + issue: &66 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -11648,7 +11229,7 @@ paths: milestone: anyOf: - type: 'null' - - &238 + - &244 title: Milestone description: A collection of related issues and pull requests. @@ -11820,7 +11401,7 @@ paths: timeline_url: type: string format: uri - type: &199 + type: &205 title: Issue Type description: The type of issue. type: @@ -11874,12 +11455,12 @@ paths: - node_id - name - description - repository: *66 + repository: *64 performed_via_github_app: anyOf: - type: 'null' - *5 - author_association: &69 + author_association: &67 title: author_association type: string description: How the author is associated with the @@ -11895,7 +11476,7 @@ paths: - OWNER examples: - OWNER - reactions: &70 + reactions: &68 title: Reaction Rollup type: object properties: @@ -11931,7 +11512,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &617 + sub_issues_summary: &622 title: Sub-issues Summary type: object properties: @@ -11952,7 +11533,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &618 + issue_dependencies_summary: &623 title: Issue Dependencies Summary type: object properties: @@ -11971,7 +11552,7 @@ paths: - total_blocking issue_field_values: type: array - items: &619 + items: &624 title: Issue Field Value description: A value assigned to an issue field type: object @@ -12071,10 +11652,10 @@ paths: assignees: type: array items: *4 - label: *67 + label: *65 labels: type: array - items: *67 + items: *65 required: - action - issue @@ -12083,8 +11664,8 @@ paths: properties: action: type: string - issue: *68 - comment: &506 + issue: *66 + comment: &501 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -12134,12 +11715,12 @@ paths: issue_url: type: string format: uri - author_association: *69 + author_association: *67 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *70 + reactions: *68 required: - id - node_id @@ -12318,7 +11899,7 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 allow_forking: type: boolean is_template: @@ -12409,7 +11990,7 @@ paths: type: string number: type: integer - pull_request: &72 + pull_request: &70 title: Pull Request Minimal type: object properties: @@ -12480,10 +12061,10 @@ paths: assignees: type: array items: *4 - label: *67 + label: *65 labels: type: array - items: *67 + items: *65 required: - action - number @@ -12493,7 +12074,7 @@ paths: properties: action: type: string - pull_request: *72 + pull_request: *70 comment: type: object properties: @@ -12747,7 +12328,7 @@ paths: - pull_request updated_at: type: string - pull_request: *72 + pull_request: *70 required: - action - review @@ -12796,7 +12377,7 @@ paths: updated_at: type: string format: date-time - reactions: *70 + reactions: *68 required: - action - comment @@ -12807,7 +12388,7 @@ paths: type: string release: allOf: - - &558 + - &555 title: Release description: A release. type: object @@ -12889,7 +12470,7 @@ paths: author: *4 assets: type: array - items: &559 + items: &556 title: Release Asset description: Data related to a release. type: object @@ -12964,7 +12545,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *70 + reactions: *68 required: - assets_url - upload_url @@ -13057,7 +12638,19 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': *73 + '503': &99 + 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 @@ -13147,7 +12740,7 @@ paths: _links: type: object properties: - timeline: &74 + timeline: &71 title: Link With Type description: Hypermedia Link with Type type: object @@ -13159,17 +12752,17 @@ paths: required: - href - type - user: *74 - security_advisories: *74 - current_user: *74 - current_user_public: *74 - current_user_actor: *74 - current_user_organization: *74 + user: *71 + security_advisories: *71 + current_user: *71 + current_user_public: *71 + current_user_actor: *71 + current_user_organization: *71 current_user_organizations: type: array - items: *74 - repository_discussions: *74 - repository_discussions_category: *74 + items: *71 + repository_discussions: *71 + repository_discussions_category: *71 required: - timeline - user @@ -13231,7 +12824,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *75 + - *72 - *17 - *19 responses: @@ -13241,7 +12834,7 @@ paths: application/json: schema: type: array - items: &76 + items: &73 title: Base Gist description: Base Gist type: object @@ -13338,7 +12931,7 @@ paths: - created_at - updated_at examples: - default: &77 + default: &74 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -13383,7 +12976,7 @@ paths: site_admin: false truncated: false headers: - Link: *57 + Link: *52 '304': *35 '403': *27 x-github: @@ -13462,7 +13055,7 @@ paths: description: Response content: application/json: - schema: &78 + schema: &75 title: Gist Simple description: Gist Simple type: object @@ -13480,7 +13073,7 @@ paths: url: type: string format: uri - user: &631 + user: &636 title: Public User description: Public User type: object @@ -13854,7 +13447,7 @@ paths: truncated: type: boolean examples: - default: &79 + default: &76 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -13958,7 +13551,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *75 + - *72 - *17 - *19 responses: @@ -13968,11 +13561,11 @@ paths: application/json: schema: type: array - items: *76 + items: *73 examples: - default: *77 + default: *74 headers: - Link: *57 + Link: *52 '422': *15 '304': *35 '403': *27 @@ -13992,7 +13585,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *75 + - *72 - *17 - *19 responses: @@ -14002,11 +13595,11 @@ paths: application/json: schema: type: array - items: *76 + items: *73 examples: - default: *77 + default: *74 headers: - Link: *57 + Link: *52 '401': *23 '304': *35 '403': *27 @@ -14032,7 +13625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &80 + - &77 name: gist_id description: The unique identifier of the gist. in: path @@ -14044,10 +13637,10 @@ paths: description: Response content: application/json: - schema: *78 + schema: *75 examples: - default: *79 - '403': &83 + default: *76 + '403': &80 description: Forbidden Gist content: application/json: @@ -14096,7 +13689,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *80 + - *77 requestBody: required: true content: @@ -14160,9 +13753,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *75 examples: - updateGist: *79 + updateGist: *76 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -14320,7 +13913,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *80 + - *77 responses: '204': description: Response @@ -14349,7 +13942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *80 + - *77 - *17 - *19 responses: @@ -14359,7 +13952,7 @@ paths: application/json: schema: type: array - items: &81 + items: &78 title: Gist Comment description: A comment made to a gist. type: object @@ -14397,7 +13990,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *69 + author_association: *67 required: - url - id @@ -14437,7 +14030,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -14462,7 +14055,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *80 + - *77 requestBody: required: true content: @@ -14488,9 +14081,9 @@ paths: description: Response content: application/json: - schema: *81 + schema: *78 examples: - default: &82 + default: &79 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -14548,8 +14141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *80 - - &84 + - *77 + - &81 name: comment_id description: The unique identifier of the comment. in: path @@ -14562,12 +14155,12 @@ paths: description: Response content: application/json: - schema: *81 + schema: *78 examples: - default: *82 + default: *79 '304': *35 '404': *6 - '403': *83 + '403': *80 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14589,8 +14182,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *80 - - *84 + - *77 + - *81 requestBody: required: true content: @@ -14616,9 +14209,9 @@ paths: description: Response content: application/json: - schema: *81 + schema: *78 examples: - default: *82 + default: *79 '404': *6 x-github: githubCloudOnly: false @@ -14635,8 +14228,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *80 - - *84 + - *77 + - *81 responses: '204': description: Response @@ -14659,7 +14252,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *80 + - *77 - *17 - *19 responses: @@ -14760,7 +14353,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *80 + - *77 - *17 - *19 responses: @@ -14770,7 +14363,7 @@ paths: application/json: schema: type: array - items: *78 + items: *75 examples: default: value: @@ -14816,7 +14409,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 '404': *6 '304': *35 '403': *27 @@ -14835,13 +14428,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *80 + - *77 responses: '201': description: Response content: application/json: - schema: *76 + schema: *73 examples: default: value: @@ -14912,7 +14505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *80 + - *77 responses: '204': description: Response if gist is starred @@ -14942,7 +14535,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *80 + - *77 responses: '204': description: Response @@ -14964,7 +14557,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *80 + - *77 responses: '204': description: Response @@ -14993,7 +14586,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *80 + - *77 - name: sha in: path required: true @@ -15004,9 +14597,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *75 examples: - default: *79 + default: *76 '422': *15 '404': *6 '403': *27 @@ -15167,7 +14760,7 @@ paths: type: integer repositories: type: array - items: *66 + items: *64 repository_selection: type: string examples: @@ -15291,7 +14884,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *57 + Link: *52 '403': *27 '304': *35 '401': *23 @@ -15375,7 +14968,7 @@ paths: - closed - all default: open - - &202 + - &208 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -15394,7 +14987,7 @@ paths: - comments default: created - *46 - - *75 + - *72 - name: collab in: query required: false @@ -15424,9 +15017,9 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: &203 + default: &209 value: - id: 1 node_id: MDU6SXNzdWUx @@ -15671,7 +15264,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *57 + Link: *52 '422': *15 '304': *35 '404': *6 @@ -15706,7 +15299,7 @@ paths: application/json: schema: type: array - items: *71 + items: *69 examples: default: value: @@ -16004,7 +15597,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &85 + X-CommonMarker-Version: &82 example: 0.17.4 schema: type: string @@ -16059,7 +15652,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *85 + X-CommonMarker-Version: *82 content: text/html: schema: @@ -16088,7 +15681,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &88 + - &85 name: account_id description: account_id parameter in: path @@ -16100,7 +15693,7 @@ paths: description: Response content: application/json: - schema: &87 + schema: &84 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -16134,7 +15727,7 @@ paths: - 'null' id: type: integer - plan: &86 + plan: &83 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -16237,7 +15830,7 @@ paths: - 'null' updated_at: type: string - plan: *86 + plan: *83 required: - url - id @@ -16245,7 +15838,7 @@ paths: - login - marketplace_purchase examples: - default: &89 + default: &86 value: url: https://api.github.com/orgs/github type: Organization @@ -16330,9 +15923,9 @@ paths: application/json: schema: type: array - items: *86 + items: *83 examples: - default: &90 + default: &87 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -16350,7 +15943,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *57 + Link: *52 '404': *6 '401': *23 x-github: @@ -16372,14 +15965,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &91 + - &88 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &92 + - &89 name: sort description: The property to sort the results by. in: query @@ -16409,9 +16002,9 @@ paths: application/json: schema: type: array - items: *87 + items: *84 examples: - default: &93 + default: &90 value: - url: https://api.github.com/orgs/github type: Organization @@ -16462,7 +16055,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *57 + Link: *52 '404': *6 '422': *15 '401': *23 @@ -16485,15 +16078,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *88 + - *85 responses: '200': description: Response content: application/json: - schema: *87 + schema: *84 examples: - default: *89 + default: *86 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -16525,11 +16118,11 @@ paths: application/json: schema: type: array - items: *86 + items: *83 examples: - default: *90 + default: *87 headers: - Link: *57 + Link: *52 '401': *23 x-github: githubCloudOnly: false @@ -16550,8 +16143,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *91 - - *92 + - *88 + - *89 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -16571,11 +16164,11 @@ paths: application/json: schema: type: array - items: *87 + items: *84 examples: - default: *93 + default: *90 headers: - Link: *57 + Link: *52 '401': *23 x-github: githubCloudOnly: false @@ -16838,14 +16431,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &314 + - &309 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &315 + - &310 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16862,7 +16455,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -16907,7 +16500,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &323 + '301': &318 description: Moved permanently content: application/json: @@ -16929,7 +16522,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &534 + - &529 name: all description: If `true`, show notifications marked as read. in: query @@ -16937,7 +16530,7 @@ paths: schema: type: boolean default: false - - &535 + - &530 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16946,8 +16539,8 @@ paths: schema: type: boolean default: false - - *75 - - &536 + - *72 + - &531 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: @@ -16972,14 +16565,14 @@ paths: application/json: schema: type: array - items: &95 + items: &92 title: Thread description: Thread type: object properties: id: type: string - repository: &131 + repository: &135 title: Minimal Repository description: Minimal Repository type: object @@ -17318,7 +16911,7 @@ paths: type: boolean examples: - false - security_and_analysis: &250 + security_and_analysis: &255 type: - object - 'null' @@ -17483,7 +17076,7 @@ paths: - url - subscription_url examples: - default: &537 + default: &532 value: - id: '1' repository: @@ -17565,7 +17158,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -17649,7 +17242,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &96 + - &93 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 @@ -17663,7 +17256,7 @@ paths: description: Response content: application/json: - schema: *95 + schema: *92 examples: default: value: @@ -17765,7 +17358,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *96 + - *93 responses: '205': description: Reset Content @@ -17787,7 +17380,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *96 + - *93 responses: '204': description: No content @@ -17810,13 +17403,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *96 + - *93 responses: '200': description: Response content: application/json: - schema: &97 + schema: &94 title: Thread Subscription description: Thread Subscription type: object @@ -17860,7 +17453,7 @@ paths: - url - subscribed examples: - default: &98 + default: &95 value: subscribed: true ignored: false @@ -17891,7 +17484,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *96 + - *93 requestBody: required: false content: @@ -17912,9 +17505,9 @@ paths: description: Response content: application/json: - schema: *97 + schema: *94 examples: - default: *98 + default: *95 '304': *35 '403': *27 '401': *23 @@ -17937,7 +17530,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *96 + - *93 responses: '204': description: Response @@ -18032,92 +17625,9 @@ paths: application/json: schema: type: array - items: &160 - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - examples: - - github - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github - repos_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/events - hooks_url: - type: string - examples: - - https://api.github.com/orgs/github/hooks - issues_url: - type: string - examples: - - https://api.github.com/orgs/github/issues - members_url: - type: string - examples: - - https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - examples: - - https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - examples: - - https://github.com/images/error/octocat_happy.gif - description: - type: - - string - - 'null' - examples: - - A great organization - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description + items: *59 examples: - default: &647 - 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: *96 headers: Link: example: ; rel="next" @@ -18144,13 +17654,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: - - &99 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string + - *61 - name: page in: query description: The page number of results to fetch. @@ -18301,7 +17805,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -18367,7 +17871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *99 + - *61 requestBody: required: true content: @@ -18401,12 +17905,134 @@ 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: + - *61 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &97 + 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 + type: + - 'null' + - string + - array + required: + - property_name + - value + examples: + default: &538 + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + '403': *27 + '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: + - *61 + 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: *97 + required: + - properties + examples: + default: &539 + 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': *27 + '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 @@ -18414,8 +18040,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - - *99 - - &101 + - *61 + - &100 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, @@ -18424,7 +18050,7 @@ paths: required: false schema: type: integer - - &673 + - &677 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 @@ -18433,7 +18059,7 @@ paths: required: false schema: type: integer - - &102 + - &101 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 @@ -18448,14 +18074,14 @@ paths: required: false schema: type: string - - &674 + - &678 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &675 + - &679 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -18517,19 +18143,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 @@ -18571,8 +18197,8 @@ paths: '400': *14 '403': *27 '404': *6 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18592,9 +18218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - *99 - - *101 - - &678 + - *61 + - *100 + - &682 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 @@ -18603,8 +18229,8 @@ paths: required: false schema: type: integer - - *102 - - &679 + - *101 + - &683 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 @@ -18687,8 +18313,8 @@ paths: repositoryName: github/example '400': *14 '403': *27 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18714,13 +18340,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &103 + schema: &102 title: Organization Full description: Organization Full type: object @@ -19115,7 +18741,7 @@ paths: - updated_at - archived_at examples: - default-response: &104 + default-response: &103 value: login: github id: 1 @@ -19215,7 +18841,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *99 + - *61 requestBody: required: false content: @@ -19432,17 +19058,17 @@ paths: description: Response content: application/json: - schema: *103 + schema: *102 examples: - default: *104 + default: *103 '422': description: Validation failed content: application/json: schema: oneOf: + - *104 - *105 - - *106 '409': *45 x-github: githubCloudOnly: false @@ -19466,7 +19092,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *99 + - *61 responses: '202': *37 '404': *6 @@ -19491,7 +19117,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -19517,7 +19143,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19538,7 +19164,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: - - *99 + - *61 - *17 - *19 responses: @@ -19556,7 +19182,7 @@ paths: type: integer repository_cache_usages: type: array - items: &328 + items: &323 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -19594,7 +19220,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19614,7 +19240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *99 + - *61 - *17 - *19 responses: @@ -19632,7 +19258,7 @@ paths: type: integer runners: type: array - items: &107 + items: &106 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -19684,12 +19310,18 @@ paths: - github - partner - custom + version: + description: The image version of the hosted runner + pool. + type: string + examples: + - latest required: - id - size_gb - display_name - source - machine_size_details: &110 + machine_size_details: &114 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -19785,6 +19417,10 @@ paths: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled + for the hosted runners. required: - id - name @@ -19794,7 +19430,7 @@ paths: - public_ip_enabled - platform examples: - default: &130 + default: &134 value: total_count: 2 runners: @@ -19836,7 +19472,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19854,7 +19490,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -19883,6 +19519,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -19900,6 +19542,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 @@ -19921,9 +19568,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *106 examples: - default: &111 + default: &115 value: id: 5 name: My hosted ubuntu runner @@ -19950,6 +19597,320 @@ 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: + - *61 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: &107 + 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 + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with + the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the + image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with + the image. + type: string + examples: + - Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + examples: + default: &109 + 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: + - *61 + - &108 + 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: *107 + 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: + - *61 + - *108 + 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: + - *108 + - *61 + 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: &110 + 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 + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - None + required: + - version + - state + - size_gb + - created_on + - state_details + examples: + default: *109 + 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: + - *61 + - *108 + - &111 + 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: *110 + 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: + - *61 + - *108 + - *111 + 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 @@ -19962,7 +19923,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: - - *99 + - *61 responses: '200': description: Response @@ -19978,7 +19939,7 @@ paths: type: integer images: type: array - items: &108 + items: &112 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -20018,7 +19979,7 @@ paths: - display_name - source examples: - default: &109 + default: &113 value: id: ubuntu-20.04 platform: linux-x64 @@ -20042,7 +20003,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: - - *99 + - *61 responses: '200': description: Response @@ -20058,9 +20019,9 @@ paths: type: integer images: type: array - items: *108 + items: *112 examples: - default: *109 + default: *113 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20077,7 +20038,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: - - *99 + - *61 responses: '200': description: Response @@ -20132,7 +20093,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: - - *99 + - *61 responses: '200': description: Response @@ -20148,7 +20109,7 @@ paths: type: integer machine_specs: type: array - items: *110 + items: *114 examples: default: value: @@ -20173,7 +20134,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: - - *99 + - *61 responses: '200': description: Response @@ -20217,8 +20178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *99 - - &112 + - *61 + - &116 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -20230,11 +20191,11 @@ paths: description: Response content: application/json: - schema: *107 + schema: *106 examples: - default: *111 + default: *115 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20252,8 +20213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *99 - - *112 + - *61 + - *116 requestBody: required: true content: @@ -20279,6 +20240,12 @@ 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 + - 'null' examples: default: value: @@ -20291,9 +20258,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *106 examples: - default: *111 + default: *115 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20309,16 +20276,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *99 - - *112 + - *61 + - *116 responses: '202': description: Response content: application/json: - schema: *107 + schema: *106 examples: - default: *111 + default: *115 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -20338,13 +20305,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: - - *99 + - *61 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &113 + schema: &117 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -20358,7 +20325,7 @@ paths: required: - include_claim_keys examples: - default: &114 + default: &118 value: include_claim_keys: - repo @@ -20380,20 +20347,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: - - *99 + - *61 requestBody: required: true content: application/json: - schema: *113 + schema: *117 examples: - default: *114 + default: *118 responses: '201': description: Empty response content: application/json: - schema: &140 + schema: &144 title: Empty Object description: An object without any properties. type: object @@ -20423,7 +20390,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -20432,7 +20399,7 @@ paths: schema: type: object properties: - enabled_repositories: &115 + enabled_repositories: &119 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -20445,7 +20412,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: &116 + allowed_actions: &120 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -20453,12 +20420,12 @@ paths: - all - local_only - selected - selected_actions_url: &334 + selected_actions_url: &329 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: &117 + sha_pinning_required: &121 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -20489,7 +20456,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Response @@ -20500,9 +20467,9 @@ paths: schema: type: object properties: - enabled_repositories: *115 - allowed_actions: *116 - sha_pinning_required: *117 + enabled_repositories: *119 + allowed_actions: *120 + sha_pinning_required: *121 required: - enabled_repositories examples: @@ -20530,13 +20497,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &338 + schema: &333 type: object properties: days: @@ -20573,12 +20540,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: application/json: - schema: &339 + schema: &334 type: object properties: days: @@ -20615,13 +20582,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &118 + schema: &122 type: object properties: approval_policy: @@ -20635,7 +20602,7 @@ paths: required: - approval_policy examples: - default: &340 + default: &335 value: approval_policy: first_time_contributors '404': *6 @@ -20656,7 +20623,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Response @@ -20666,7 +20633,7 @@ paths: required: true content: application/json: - schema: *118 + schema: *122 examples: default: summary: Set approval policy to first time contributors @@ -20688,13 +20655,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: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &341 + schema: &336 type: object required: - run_workflows_from_fork_pull_requests @@ -20720,7 +20687,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &119 + default: &123 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -20743,12 +20710,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: - - *99 + - *61 requestBody: required: true content: application/json: - schema: &342 + schema: &337 type: object required: - run_workflows_from_fork_pull_requests @@ -20771,7 +20738,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *119 + default: *123 responses: '204': description: Empty response for successful settings update @@ -20801,7 +20768,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: - - *99 + - *61 - *17 - *19 responses: @@ -20819,9 +20786,9 @@ paths: type: number repositories: type: array - items: *66 + items: *64 examples: - default: &123 + default: &127 value: total_count: 1 repositories: @@ -20961,7 +20928,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: - - *99 + - *61 responses: '204': description: Response @@ -21005,8 +20972,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: - - *99 - - &120 + - *61 + - &124 name: repository_id description: The unique identifier of the repository. in: path @@ -21034,8 +21001,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: - - *99 - - *120 + - *61 + - *124 responses: '204': description: Response @@ -21058,13 +21025,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &121 + schema: &125 type: object properties: github_owned_allowed: @@ -21086,7 +21053,7 @@ paths: items: type: string examples: - default: &122 + default: &126 value: github_owned_allowed: true verified_allowed: false @@ -21111,7 +21078,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Response @@ -21119,9 +21086,9 @@ paths: required: false content: application/json: - schema: *121 + schema: *125 examples: - selected_actions: *122 + selected_actions: *126 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21141,7 +21108,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -21189,7 +21156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -21236,7 +21203,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: - - *99 + - *61 - *17 - *19 responses: @@ -21251,9 +21218,9 @@ paths: type: integer repositories: type: array - items: *66 + items: *64 examples: - default: *123 + default: *127 '403': *27 '404': *6 x-github: @@ -21273,7 +21240,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: - - *99 + - *61 requestBody: required: true content: @@ -21321,8 +21288,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: - - *99 - - *120 + - *61 + - *124 responses: '204': description: No content @@ -21348,8 +21315,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: - - *99 - - *120 + - *61 + - *124 responses: '204': description: No content @@ -21377,23 +21344,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &343 + schema: &338 type: object properties: - default_workflow_permissions: &124 + default_workflow_permissions: &128 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &125 + can_approve_pull_request_reviews: &129 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -21401,7 +21368,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &126 + default: &130 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -21426,7 +21393,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Success response @@ -21434,13 +21401,13 @@ paths: required: false content: application/json: - schema: &344 + schema: &339 type: object properties: - default_workflow_permissions: *124 - can_approve_pull_request_reviews: *125 + default_workflow_permissions: *128 + can_approve_pull_request_reviews: *129 examples: - default: *126 + default: *130 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21460,7 +21427,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: - - *99 + - *61 - *17 - *19 - name: visible_to_repository @@ -21485,7 +21452,7 @@ paths: type: number runner_groups: type: array - items: &127 + items: &131 type: object properties: id: @@ -21602,7 +21569,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: - - *99 + - *61 requestBody: required: true content: @@ -21675,9 +21642,9 @@ paths: description: Response content: application/json: - schema: *127 + schema: *131 examples: - default: &129 + default: &133 value: id: 2 name: octo-runner-group @@ -21712,8 +21679,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: - - *99 - - &128 + - *61 + - &132 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -21725,7 +21692,7 @@ paths: description: Response content: application/json: - schema: *127 + schema: *131 examples: default: value: @@ -21761,8 +21728,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: - - *99 - - *128 + - *61 + - *132 requestBody: required: true content: @@ -21818,9 +21785,9 @@ paths: description: Response content: application/json: - schema: *127 + schema: *131 examples: - default: *129 + default: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21839,8 +21806,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: - - *99 - - *128 + - *61 + - *132 responses: '204': description: Response @@ -21863,8 +21830,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: - - *99 - - *128 + - *61 + - *132 - *17 - *19 responses: @@ -21882,11 +21849,11 @@ paths: type: number runners: type: array - items: *107 + items: *106 examples: - default: *130 + default: *134 headers: - Link: *57 + Link: *52 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21906,8 +21873,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: - - *99 - - *128 + - *61 + - *132 - *19 - *17 responses: @@ -21925,9 +21892,9 @@ paths: type: number repositories: type: array - items: *131 + items: *135 examples: - default: &634 + default: &639 value: total_count: 1 repositories: @@ -22179,8 +22146,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: - - *99 - - *128 + - *61 + - *132 requestBody: required: true content: @@ -22224,9 +22191,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: - - *99 - - *128 - - *120 + - *61 + - *132 + - *124 responses: '204': description: Response @@ -22248,9 +22215,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: - - *99 - - *128 - - *120 + - *61 + - *132 + - *124 responses: '204': description: Response @@ -22273,8 +22240,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: - - *99 - - *128 + - *61 + - *132 - *17 - *19 responses: @@ -22292,7 +22259,7 @@ paths: type: number runners: type: array - items: &133 + items: &137 title: Self hosted runners description: A self hosted runner type: object @@ -22326,7 +22293,7 @@ paths: type: boolean labels: type: array - items: &136 + items: &140 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -22356,7 +22323,7 @@ paths: - busy - labels examples: - default: &134 + default: &138 value: total_count: 2 runners: @@ -22396,7 +22363,7 @@ paths: name: no-gpu type: custom headers: - Link: *57 + Link: *52 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22415,8 +22382,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: - - *99 - - *128 + - *61 + - *132 requestBody: required: true content: @@ -22460,9 +22427,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: - - *99 - - *128 - - &132 + - *61 + - *132 + - &136 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -22490,9 +22457,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: - - *99 - - *128 + - *61 - *132 + - *136 responses: '204': description: Response @@ -22522,7 +22489,7 @@ paths: in: query schema: type: string - - *99 + - *61 - *17 - *19 responses: @@ -22540,11 +22507,11 @@ paths: type: integer runners: type: array - items: *133 + items: *137 examples: - default: *134 + default: *138 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22566,7 +22533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -22574,7 +22541,7 @@ paths: application/json: schema: type: array - items: &345 + items: &340 title: Runner Application description: Runner Application type: object @@ -22599,7 +22566,7 @@ paths: - download_url - filename examples: - default: &346 + default: &341 value: - os: osx architecture: x64 @@ -22642,7 +22609,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: - - *99 + - *61 requestBody: required: true content: @@ -22685,7 +22652,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &347 + '201': &342 description: Response content: application/json: @@ -22695,7 +22662,7 @@ paths: - runner - encoded_jit_config properties: - runner: *133 + runner: *137 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -22752,13 +22719,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *99 + - *61 responses: '201': description: Response content: application/json: - schema: &135 + schema: &139 title: Authentication Token description: Authentication Token type: object @@ -22782,7 +22749,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *66 + items: *64 single_file: type: - string @@ -22800,7 +22767,7 @@ paths: - token - expires_at examples: - default: &348 + default: &343 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -22831,15 +22798,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *99 + - *61 responses: '201': description: Response content: application/json: - schema: *135 + schema: *139 examples: - default: &349 + default: &344 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -22864,16 +22831,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: - - *99 - - *132 + - *61 + - *136 responses: '200': description: Response content: application/json: - schema: *133 + schema: *137 examples: - default: &350 + default: &345 value: id: 23 name: MBP @@ -22914,8 +22881,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: - - *99 - - *132 + - *61 + - *136 responses: '204': description: Response @@ -22941,10 +22908,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: - - *99 - - *132 + - *61 + - *136 responses: - '200': &137 + '200': &141 description: Response content: application/json: @@ -22958,7 +22925,7 @@ paths: type: integer labels: type: array - items: *136 + items: *140 examples: default: value: @@ -22997,8 +22964,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: - - *99 - - *132 + - *61 + - *136 requestBody: required: true content: @@ -23022,7 +22989,7 @@ paths: - gpu - accelerated responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -23046,8 +23013,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: - - *99 - - *132 + - *61 + - *136 requestBody: required: true content: @@ -23072,7 +23039,7 @@ paths: - gpu - accelerated responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -23096,10 +23063,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: - - *99 - - *132 + - *61 + - *136 responses: - '200': &351 + '200': &346 description: Response content: application/json: @@ -23113,7 +23080,7 @@ paths: type: integer labels: type: array - items: *136 + items: *140 examples: default: value: @@ -23154,9 +23121,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: - - *99 - - *132 - - &352 + - *61 + - *136 + - &347 name: name description: The name of a self-hosted runner's custom label. in: path @@ -23164,7 +23131,7 @@ paths: schema: type: string responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -23189,7 +23156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *99 + - *61 - *17 - *19 responses: @@ -23207,7 +23174,7 @@ paths: type: integer secrets: type: array - items: &138 + items: &142 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -23259,7 +23226,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23282,13 +23249,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &364 + schema: &359 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -23323,7 +23290,7 @@ paths: - key_id - key examples: - default: &365 + default: &360 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23348,8 +23315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *99 - - &139 + - *61 + - &143 name: secret_name description: The name of the secret. in: path @@ -23361,7 +23328,7 @@ paths: description: Response content: application/json: - schema: *138 + schema: *142 examples: default: value: @@ -23391,8 +23358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -23449,7 +23416,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -23475,8 +23442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 responses: '204': description: Response @@ -23502,8 +23469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - *19 - *17 responses: @@ -23521,9 +23488,9 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: &143 + default: &147 value: total_count: 1 repositories: @@ -23615,8 +23582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -23668,8 +23635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -23702,8 +23669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -23735,8 +23702,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *99 - - &333 + - *61 + - &328 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)." @@ -23760,7 +23727,7 @@ paths: type: integer variables: type: array - items: &141 + items: &145 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -23829,7 +23796,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23850,7 +23817,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *99 + - *61 requestBody: required: true content: @@ -23898,7 +23865,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -23923,8 +23890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *99 - - &142 + - *61 + - &146 name: name description: The name of the variable. in: path @@ -23936,7 +23903,7 @@ paths: description: Response content: application/json: - schema: *141 + schema: *145 examples: default: value: @@ -23966,8 +23933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 requestBody: required: true content: @@ -24029,8 +23996,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 responses: '204': description: Response @@ -24056,8 +24023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 - *19 - *17 responses: @@ -24075,9 +24042,9 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: *143 + default: *147 '409': description: Response when the visibility of the variable is not set to `selected` @@ -24103,8 +24070,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 requestBody: required: true content: @@ -24153,8 +24120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 - name: repository_id in: path required: true @@ -24188,8 +24155,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 - name: repository_id in: path required: true @@ -24220,7 +24187,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *99 + - *61 requestBody: required: true content: @@ -24362,7 +24329,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *99 + - *61 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24448,7 +24415,7 @@ paths: - *17 - *38 - *39 - - *99 + - *61 requestBody: required: true content: @@ -24471,12 +24438,12 @@ paths: required: - subject_digests examples: - default: &662 + default: &666 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &663 + withPredicateType: &667 value: subject_digests: - sha256:abc123 @@ -24535,7 +24502,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &664 + default: &668 value: attestations_subject_digests: - sha256:abc: @@ -24644,7 +24611,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *99 + - *61 requestBody: required: true content: @@ -24709,7 +24676,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *99 + - *61 - name: subject_digest description: Subject Digest in: path @@ -24728,6 +24695,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 + - *38 + - *39 + - *61 + - 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 @@ -24740,7 +24758,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *99 + - *61 - name: attestation_id description: Attestation ID in: path @@ -24778,7 +24796,7 @@ paths: - *17 - *38 - *39 - - *99 + - *61 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24831,7 +24849,7 @@ paths: initiator: type: string examples: - default: &378 + default: &373 value: attestations: - bundle: @@ -24938,7 +24956,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *99 + - *61 - *17 - *19 responses: @@ -24950,7 +24968,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24969,8 +24987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: If the user is blocked @@ -24995,8 +25013,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -25016,8 +25034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -25042,7 +25060,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *99 + - *61 - *19 - *17 - *46 @@ -25050,7 +25068,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &144 + schema: &148 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -25076,7 +25094,7 @@ paths: application/json: schema: type: array - items: &145 + items: &149 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -25107,7 +25125,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &161 + items: &169 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -25184,7 +25202,7 @@ paths: parent: anyOf: - type: 'null' - - &214 + - &220 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -25320,7 +25338,7 @@ paths: - string - 'null' format: date-time - state: *144 + state: *148 contact_link: description: The contact link of the campaign. type: @@ -25416,9 +25434,9 @@ paths: closed_at: state: open headers: - Link: *57 + Link: *52 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25442,7 +25460,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -25489,7 +25507,9 @@ paths: format: uri code_scanning_alerts: description: The code scanning alerts to include in this campaign - type: array + type: + - array + - 'null' minItems: 1 items: type: object @@ -25516,7 +25536,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -25537,9 +25561,9 @@ paths: description: Response content: application/json: - schema: *145 + schema: *149 examples: - default: &146 + default: &150 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -25588,7 +25612,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25610,7 +25634,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *99 + - *61 - name: campaign_number description: The campaign number. in: path @@ -25622,16 +25646,16 @@ paths: description: Response content: application/json: - schema: *145 + schema: *149 examples: - default: *146 + default: *150 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25652,7 +25676,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *99 + - *61 - name: campaign_number description: The campaign number. in: path @@ -25702,7 +25726,7 @@ paths: - string - 'null' format: uri - state: *144 + state: *148 examples: default: value: @@ -25712,9 +25736,9 @@ paths: description: Response content: application/json: - schema: *145 + schema: *149 examples: - default: *146 + default: *150 '400': description: Bad Request content: @@ -25726,7 +25750,7 @@ paths: content: application/json: schema: *3 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25747,7 +25771,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *99 + - *61 - name: campaign_number description: The campaign number. in: path @@ -25758,7 +25782,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25780,18 +25804,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *99 - - &402 + - *61 + - &397 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: &149 + schema: &158 type: string description: The name of the tool used to generate the code scanning analysis. - - &403 + - &398 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 @@ -25799,7 +25823,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &150 + schema: &159 type: - string - 'null' @@ -25815,7 +25839,7 @@ paths: be returned. in: query required: false - schema: &405 + schema: &400 type: string description: State of a code scanning alert. enum: @@ -25838,7 +25862,7 @@ paths: be returned. in: query required: false - schema: &406 + schema: &401 type: string description: Severity of a code scanning alert. enum: @@ -25859,18 +25883,18 @@ paths: items: type: object properties: - number: *52 - created_at: *53 - updated_at: *54 - url: *55 - html_url: *56 - instances_url: &407 + number: *151 + created_at: *152 + updated_at: *153 + url: *154 + html_url: *155 + instances_url: &402 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &151 + state: &160 type: - string - 'null' @@ -25880,13 +25904,13 @@ paths: - dismissed - fixed - - fixed_at: *147 + fixed_at: *156 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *148 - dismissed_reason: &408 + dismissed_at: *157 + dismissed_reason: &403 type: - string - 'null' @@ -25897,14 +25921,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &409 + dismissed_comment: &404 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &410 + rule: &405 type: object properties: id: @@ -25965,26 +25989,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &411 + tool: &406 type: object properties: - name: *149 + name: *158 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *150 - most_recent_instance: &412 + guid: *159 + most_recent_instance: &407 type: object properties: - ref: &404 + ref: &399 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &422 + analysis_key: &417 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -25995,13 +26019,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &423 + category: &418 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: *151 + state: *160 commit_sha: type: string message: @@ -26294,9 +26318,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: *57 + Link: *52 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26318,7 +26342,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *99 + - *61 - name: target_type in: query description: The target type of the code security configuration @@ -26429,7 +26453,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *99 + - *61 requestBody: required: true content: @@ -26507,7 +26531,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *152 + code_scanning_options: *161 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -26650,7 +26674,7 @@ paths: application/json: schema: *41 examples: - default: *153 + default: *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26672,15 +26696,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: *154 + schema: *163 examples: - default: *155 + default: *164 '304': *35 '403': *27 '404': *6 @@ -26706,7 +26730,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *99 + - *61 requestBody: required: true content: @@ -26732,7 +26756,7 @@ paths: - 32 - 91 responses: - '204': *156 + '204': *165 '400': *14 '403': *27 '404': *6 @@ -26758,7 +26782,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *99 + - *61 - *43 responses: '200': @@ -26767,7 +26791,7 @@ paths: application/json: schema: *41 examples: - default: *153 + default: *162 '304': *35 '403': *27 '404': *6 @@ -26791,7 +26815,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *99 + - *61 - *43 requestBody: required: true @@ -27048,10 +27072,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *99 + - *61 - *43 responses: - '204': *156 + '204': *165 '400': *14 '403': *27 '404': *6 @@ -27079,7 +27103,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *99 + - *61 - *43 requestBody: required: true @@ -27143,7 +27167,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: - - *99 + - *61 - *43 requestBody: required: true @@ -27189,7 +27213,7 @@ paths: default: value: default_for_new_repos: all - configuration: *153 + configuration: *162 '403': *27 '404': *6 x-github: @@ -27213,7 +27237,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *99 + - *61 - *43 - name: per_page description: The number of results per page (max 100). For more information, @@ -27242,13 +27266,13 @@ paths: application/json: schema: type: array - items: *157 + items: *166 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *158 + repository: *167 '403': *27 '404': *6 x-github: @@ -27272,7 +27296,7 @@ paths: parameters: - *17 - *19 - - *99 + - *61 responses: '200': description: Response @@ -27288,7 +27312,7 @@ paths: type: integer codespaces: type: array - items: &204 + items: &210 type: object title: Codespace description: A codespace. @@ -27319,11 +27343,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *131 + repository: *135 machine: anyOf: - type: 'null' - - &435 + - &430 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -27610,7 +27634,7 @@ paths: - pulls_url - recent_folders examples: - default: &205 + default: &211 value: total_count: 3 codespaces: @@ -28020,7 +28044,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -28042,7 +28066,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *99 + - *61 deprecated: true requestBody: required: true @@ -28086,7 +28110,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28109,7 +28133,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *99 + - *61 deprecated: true requestBody: required: true @@ -28141,7 +28165,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28164,7 +28188,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *99 + - *61 requestBody: required: true content: @@ -28195,7 +28219,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28216,7 +28240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *99 + - *61 - *17 - *19 responses: @@ -28234,7 +28258,7 @@ paths: type: integer secrets: type: array - items: &159 + items: &168 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -28275,7 +28299,7 @@ paths: - updated_at - visibility examples: - default: &436 + default: &431 value: total_count: 2 secrets: @@ -28288,7 +28312,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28307,13 +28331,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &437 + schema: &432 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -28348,7 +28372,7 @@ paths: - key_id - key examples: - default: &438 + default: &433 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28371,23 +28395,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 responses: '200': description: Response content: application/json: - schema: *159 + schema: *168 examples: - default: &440 + default: &435 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28407,8 +28431,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -28463,7 +28487,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -28489,8 +28513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 responses: '204': description: Response @@ -28515,8 +28539,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - *19 - *17 responses: @@ -28534,9 +28558,9 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: *143 + default: *147 '404': *6 x-github: githubCloudOnly: false @@ -28558,8 +28582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -28609,8 +28633,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -28643,8 +28667,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -28683,7 +28707,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: - - *99 + - *61 responses: '200': description: OK @@ -28792,7 +28816,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -28824,7 +28848,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: - - *99 + - *61 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -28847,7 +28871,7 @@ paths: currently being billed. seats: type: array - items: &207 + items: &213 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -28860,13 +28884,13 @@ paths: organization: anyOf: - type: 'null' - - *160 + - *59 assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *161 - - *58 + - *169 + - *53 type: - 'null' - object @@ -28996,8 +29020,8 @@ paths: type: User site_admin: false headers: - Link: *57 - '500': *100 + Link: *52 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -29030,7 +29054,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: - - *99 + - *61 requestBody: content: application/json: @@ -29072,7 +29096,7 @@ paths: default: value: seats_created: 5 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -29108,7 +29132,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: - - *99 + - *61 requestBody: content: application/json: @@ -29150,7 +29174,7 @@ paths: default: value: seats_cancelled: 5 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -29188,7 +29212,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: - - *99 + - *61 requestBody: content: application/json: @@ -29229,7 +29253,7 @@ paths: default: value: seats_created: 5 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -29265,7 +29289,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: - - *99 + - *61 requestBody: content: application/json: @@ -29307,7 +29331,7 @@ paths: default: value: seats_cancelled: 5 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -29346,7 +29370,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *99 + - *61 - 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`). @@ -29378,7 +29402,7 @@ paths: application/json: schema: type: array - items: &296 + items: &291 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -29693,7 +29717,7 @@ paths: - date additionalProperties: true examples: - default: &297 + default: &292 value: - date: '2024-06-24' total_active_users: 24 @@ -29792,10 +29816,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *100 + '500': *98 '403': *27 '404': *6 - '422': &298 + '422': &293 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -29822,12 +29846,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *99 - - *162 - - *163 - - *164 - - *165 - - *166 + - *61 + - *170 + - *171 + - *172 + - *173 + - *174 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -29865,13 +29889,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *167 - - *168 + - *175 + - *176 - *46 - *38 - *39 - - *169 - - *170 - *17 responses: '200': @@ -29880,9 +29902,9 @@ paths: application/json: schema: type: array - items: *171 + items: *177 examples: - default: *172 + default: *178 '304': *35 '400': *14 '403': *27 @@ -29908,7 +29930,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *99 + - *61 - *17 - *19 responses: @@ -29926,7 +29948,7 @@ paths: type: integer secrets: type: array - items: &173 + items: &179 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -29978,7 +30000,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29999,13 +30021,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &463 + schema: &458 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -30024,7 +30046,7 @@ paths: - key_id - key examples: - default: &464 + default: &459 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -30047,14 +30069,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 responses: '200': description: Response content: application/json: - schema: *173 + schema: *179 examples: default: value: @@ -30082,8 +30104,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -30142,7 +30164,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -30166,8 +30188,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 responses: '204': description: Response @@ -30191,8 +30213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - *19 - *17 responses: @@ -30210,9 +30232,9 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: *143 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30233,8 +30255,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -30284,8 +30306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -30316,8 +30338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -30347,7 +30369,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: - - *99 + - *61 responses: '200': description: Response @@ -30355,7 +30377,7 @@ paths: application/json: schema: type: array - items: &216 + items: &222 title: Package description: A software package type: object @@ -30408,7 +30430,7 @@ paths: repository: anyOf: - type: 'null' - - *131 + - *135 created_at: type: string format: date-time @@ -30426,7 +30448,7 @@ paths: - created_at - updated_at examples: - default: &217 + default: &223 value: - id: 197 name: hello_docker @@ -30504,7 +30526,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *99 + - *61 - *17 - *19 responses: @@ -30514,7 +30536,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: 200-response: value: @@ -30586,7 +30608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *99 + - *61 - *17 - *19 responses: @@ -30596,7 +30618,7 @@ paths: application/json: schema: type: array - items: &196 + items: &202 title: Organization Invitation description: Organization Invitation type: object @@ -30650,7 +30672,7 @@ paths: - invitation_teams_url - node_id examples: - default: &197 + default: &203 value: - id: 1 login: monalisa @@ -30683,7 +30705,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -30707,7 +30729,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *99 + - *61 - *17 - *19 responses: @@ -30717,7 +30739,7 @@ paths: application/json: schema: type: array - items: &174 + items: &180 title: Org Hook description: Org Hook type: object @@ -30817,7 +30839,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -30840,7 +30862,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *99 + - *61 requestBody: required: true content: @@ -30902,9 +30924,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *180 examples: - default: &175 + default: &181 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -30951,8 +30973,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *99 - - &176 + - *61 + - &182 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. @@ -30965,9 +30987,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *180 examples: - default: *175 + default: *181 '404': *6 x-github: githubCloudOnly: false @@ -30994,8 +31016,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 requestBody: required: false content: @@ -31041,7 +31063,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *180 examples: default: value: @@ -31082,8 +31104,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 responses: '204': description: Response @@ -31110,8 +31132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *99 - - *176 + - *61 + - *182 responses: '200': description: Response @@ -31141,8 +31163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *99 - - *176 + - *61 + - *182 requestBody: required: false content: @@ -31192,10 +31214,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 - *17 - - *177 + - *183 responses: '200': description: Response @@ -31203,9 +31225,9 @@ paths: application/json: schema: type: array - items: *178 + items: *184 examples: - default: *179 + default: *185 '400': *14 '422': *15 x-github: @@ -31230,17 +31252,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 - *16 responses: '200': description: Response content: application/json: - schema: *180 + schema: *186 examples: - default: *181 + default: *187 '400': *14 '422': *15 x-github: @@ -31265,8 +31287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 - *16 responses: '202': *37 @@ -31295,8 +31317,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 responses: '204': description: Response @@ -31318,8 +31340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *99 - - &186 + - *61 + - &192 name: actor_type in: path description: The type of the actor @@ -31332,14 +31354,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &187 + - &193 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &182 + - &188 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`.' @@ -31347,7 +31369,7 @@ paths: required: true schema: type: string - - &183 + - &189 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) @@ -31441,13 +31463,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *99 - - *182 - - *183 + - *61 + - *188 + - *189 - *19 - *17 - *46 - - &192 + - &198 name: sort description: The property to sort the results by. in: query @@ -31526,15 +31548,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *99 - - *182 - - *183 + - *61 + - *188 + - *189 responses: '200': description: Response content: application/json: - schema: &184 + schema: &190 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -31550,7 +31572,7 @@ paths: type: integer format: int64 examples: - default: &185 + default: &191 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -31570,24 +31592,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *99 - - &188 + - *61 + - &194 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *182 - - *183 + - *188 + - *189 responses: '200': description: Response content: application/json: - schema: *184 + schema: *190 examples: - default: *185 + default: *191 x-github: enabledForGitHubApps: true category: orgs @@ -31605,19 +31627,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *99 - - *182 - - *183 - - *186 - - *187 + - *61 + - *188 + - *189 + - *192 + - *193 responses: '200': description: Response content: application/json: - schema: *184 + schema: *190 examples: - default: *185 + default: *191 x-github: enabledForGitHubApps: true category: orgs @@ -31634,10 +31656,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *99 - - *182 - - *183 - - &189 + - *61 + - *188 + - *189 + - &195 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -31650,7 +31672,7 @@ paths: description: Response content: application/json: - schema: &190 + schema: &196 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -31666,7 +31688,7 @@ paths: type: integer format: int64 examples: - default: &191 + default: &197 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -31702,19 +31724,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *99 + - *61 + - *194 - *188 - - *182 - - *183 - *189 + - *195 responses: '200': description: Response content: application/json: - schema: *190 + schema: *196 examples: - default: *191 + default: *197 x-github: enabledForGitHubApps: true category: orgs @@ -31731,20 +31753,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *99 - - *186 - - *187 - - *182 - - *183 + - *61 + - *192 + - *193 + - *188 - *189 + - *195 responses: '200': description: Response content: application/json: - schema: *190 + schema: *196 examples: - default: *191 + default: *197 x-github: enabledForGitHubApps: true category: orgs @@ -31761,14 +31783,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *99 + - *61 + - *194 - *188 - - *182 - - *183 + - *189 - *19 - *17 - *46 - - *192 + - *198 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -31844,7 +31866,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *99 + - *61 responses: '200': description: Response @@ -31852,7 +31874,7 @@ paths: application/json: schema: *20 examples: - default: &502 + default: &497 value: id: 1 account: @@ -31921,7 +31943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *99 + - *61 - *17 - *19 responses: @@ -31991,7 +32013,7 @@ paths: suspended_at: suspended_by: headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32010,7 +32032,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -32018,12 +32040,12 @@ paths: application/json: schema: anyOf: - - &194 + - &200 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &193 + limit: &199 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -32051,7 +32073,7 @@ paths: properties: {} additionalProperties: false examples: - default: &195 + default: &201 value: limit: collaborators_only origin: organization @@ -32075,18 +32097,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: application/json: - schema: &503 + schema: &498 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *193 + limit: *199 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -32111,9 +32133,9 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: - default: *195 + default: *201 '422': *15 x-github: githubCloudOnly: false @@ -32131,7 +32153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Response @@ -32155,7 +32177,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *99 + - *61 - *17 - *19 - name: role @@ -32189,11 +32211,11 @@ paths: application/json: schema: type: array - items: *196 + items: *202 examples: - default: *197 + default: *203 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -32214,7 +32236,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *99 + - *61 requestBody: required: false content: @@ -32268,7 +32290,7 @@ paths: description: Response content: application/json: - schema: *196 + schema: *202 examples: default: value: @@ -32322,8 +32344,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *99 - - &198 + - *61 + - &204 name: invitation_id description: The unique identifier of the invitation. in: path @@ -32353,8 +32375,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *99 - - *198 + - *61 + - *204 - *17 - *19 responses: @@ -32364,9 +32386,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: &215 + default: &221 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -32382,7 +32404,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -32401,7 +32423,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -32409,7 +32431,7 @@ paths: application/json: schema: type: array - items: *199 + items: *205 examples: default: value: @@ -32447,7 +32469,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -32497,9 +32519,9 @@ paths: description: Response content: application/json: - schema: *199 + schema: *205 examples: - default: &200 + default: &206 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -32531,8 +32553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *99 - - &201 + - *61 + - &207 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -32588,9 +32610,9 @@ paths: description: Response content: application/json: - schema: *199 + schema: *205 examples: - default: *200 + default: *206 '404': *6 '422': *7 x-github: @@ -32614,8 +32636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *99 - - *201 + - *61 + - *207 responses: '204': description: Response @@ -32648,7 +32670,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *99 + - *61 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -32678,7 +32700,7 @@ paths: - closed - all default: open - - *202 + - *208 - name: type description: Can be the name of an issue type. in: query @@ -32697,7 +32719,7 @@ paths: - comments default: created - *46 - - *75 + - *72 - *17 - *19 responses: @@ -32707,11 +32729,11 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: *203 + default: *209 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -32731,7 +32753,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *99 + - *61 - 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) @@ -32769,9 +32791,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '422': *15 x-github: githubCloudOnly: false @@ -32789,8 +32811,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response if requester is an organization member and user is @@ -32824,8 +32846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -32851,8 +32873,8 @@ paths: parameters: - *17 - *19 - - *99 - - *62 + - *61 + - *57 responses: '200': description: Response @@ -32868,11 +32890,11 @@ paths: type: integer codespaces: type: array - items: *204 + items: *210 examples: - default: *205 + default: *211 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -32895,9 +32917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *99 - - *62 - - &206 + - *61 + - *57 + - &212 name: codespace_name in: path required: true @@ -32907,7 +32929,7 @@ paths: responses: '202': *37 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -32930,17 +32952,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *99 - - *62 - - *206 + - *61 + - *57 + - *212 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: &434 + default: &429 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -33082,7 +33104,7 @@ paths: recent_folders: [] template: '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -33113,14 +33135,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: - - *99 - - *62 + - *61 + - *57 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *207 + schema: *213 examples: default: value: @@ -33164,7 +33186,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -33189,14 +33211,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '200': description: Response content: application/json: - schema: &208 + schema: &214 title: Org Membership description: Org Membership type: object @@ -33245,7 +33267,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *160 + organization: *59 user: anyOf: - type: 'null' @@ -33265,7 +33287,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &209 + response-if-user-has-an-active-admin-membership-with-organization: &215 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -33333,8 +33355,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 requestBody: required: false content: @@ -33362,9 +33384,9 @@ paths: description: Response content: application/json: - schema: *208 + schema: *214 examples: - response-if-user-already-had-membership-with-organization: *209 + response-if-user-already-had-membership-with-organization: *215 '422': *15 '403': *27 x-github: @@ -33388,8 +33410,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -33414,7 +33436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *99 + - *61 - *17 - *19 - name: exclude @@ -33436,7 +33458,7 @@ paths: application/json: schema: type: array - items: &210 + items: &216 title: Migration description: A migration. type: object @@ -33478,7 +33500,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *66 + items: *64 url: type: string format: uri @@ -33677,7 +33699,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33693,7 +33715,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *99 + - *61 requestBody: required: true content: @@ -33774,7 +33796,7 @@ paths: description: Response content: application/json: - schema: *210 + schema: *216 examples: default: value: @@ -33952,8 +33974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *99 - - &211 + - *61 + - &217 name: migration_id description: The unique identifier of the migration. in: path @@ -33981,7 +34003,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *210 + schema: *216 examples: default: value: @@ -34150,8 +34172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *99 - - *211 + - *61 + - *217 responses: '302': description: Response @@ -34172,8 +34194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *99 - - *211 + - *61 + - *217 responses: '204': description: Response @@ -34196,9 +34218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *99 - - *211 - - &646 + - *61 + - *217 + - &651 name: repo_name description: repo_name parameter in: path @@ -34225,8 +34247,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *99 - - *211 + - *61 + - *217 - *17 - *19 responses: @@ -34236,9 +34258,9 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: &222 + default: &228 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -34349,7 +34371,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -34375,7 +34397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response - list of organization roles @@ -34391,7 +34413,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &213 + items: &219 title: Organization Role description: Organization roles type: object @@ -34540,8 +34562,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *99 - - *64 + - *61 + - *62 responses: '204': description: Response @@ -34566,9 +34588,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *99 - - *64 - - &212 + - *61 + - *62 + - &218 name: role_id description: The unique identifier of the role. in: path @@ -34603,9 +34625,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *99 - - *64 - - *212 + - *61 + - *62 + - *218 responses: '204': description: Response @@ -34630,8 +34652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -34656,9 +34678,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *99 - - *62 - - *212 + - *61 + - *57 + - *218 responses: '204': description: Response @@ -34688,9 +34710,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *99 - - *62 - - *212 + - *61 + - *57 + - *218 responses: '204': description: Response @@ -34718,14 +34740,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *99 - - *212 + - *61 + - *218 responses: '200': description: Response content: application/json: - schema: *213 + schema: *219 examples: default: value: @@ -34775,8 +34797,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: - - *99 - - *212 + - *61 + - *218 - *17 - *19 responses: @@ -34855,7 +34877,7 @@ paths: parent: anyOf: - type: 'null' - - *214 + - *220 type: description: The ownership type of the team type: string @@ -34888,9 +34910,9 @@ paths: - type - parent examples: - default: *215 + default: *221 headers: - Link: *57 + Link: *52 '404': description: Response if the organization or role does not exist. '422': @@ -34917,8 +34939,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: - - *99 - - *212 + - *61 + - *218 - *17 - *19 responses: @@ -34947,7 +34969,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *214 + items: *220 name: type: - string @@ -35064,9 +35086,9 @@ paths: - type - url examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '404': description: Response if the organization or role does not exist. '422': @@ -35088,7 +35110,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *99 + - *61 - 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) @@ -35115,9 +35137,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35140,8 +35162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *99 - - *62 + - *61 + - *57 requestBody: required: false content: @@ -35198,8 +35220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -35256,8 +35278,8 @@ paths: - docker - nuget - container - - *99 - - &648 + - *61 + - &652 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -35293,12 +35315,12 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *217 + default: *223 '403': *27 '401': *23 - '400': &650 + '400': &654 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -35320,7 +35342,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &218 + - &224 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 @@ -35338,20 +35360,20 @@ paths: - docker - nuget - container - - &219 + - &225 name: package_name description: The name of the package. in: path required: true schema: type: string - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: *216 + schema: *222 examples: default: value: @@ -35403,9 +35425,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *218 - - *219 - - *99 + - *224 + - *225 + - *61 responses: '204': description: Response @@ -35437,9 +35459,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *218 - - *219 - - *99 + - *224 + - *225 + - *61 - name: token description: package token schema: @@ -35471,9 +35493,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: - - *218 - - *219 - - *99 + - *224 + - *225 + - *61 - *19 - *17 - name: state @@ -35493,7 +35515,7 @@ paths: application/json: schema: type: array - items: &220 + items: &226 title: Package Version description: A version of a software package type: object @@ -35628,10 +35650,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *218 - - *219 - - *99 - - &221 + - *224 + - *225 + - *61 + - &227 name: package_version_id description: Unique identifier of the package version. in: path @@ -35643,7 +35665,7 @@ paths: description: Response content: application/json: - schema: *220 + schema: *226 examples: default: value: @@ -35679,10 +35701,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *218 - - *219 - - *99 - - *221 + - *224 + - *225 + - *61 + - *227 responses: '204': description: Response @@ -35714,10 +35736,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *218 - - *219 - - *99 - - *221 + - *224 + - *225 + - *61 + - *227 responses: '204': description: Response @@ -35744,10 +35766,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: - - *99 + - *61 - *17 - *19 - - &223 + - &229 name: sort description: The property by which to sort the results. in: query @@ -35758,7 +35780,7 @@ paths: - created_at default: created_at - *46 - - &224 + - &230 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -35770,7 +35792,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &225 + - &231 name: repository description: The name of the repository to use to filter the results. in: query @@ -35779,7 +35801,7 @@ paths: type: string examples: - Hello-World - - &226 + - &232 name: permission description: The permission to use to filter the results. in: query @@ -35788,7 +35810,7 @@ paths: type: string examples: - issues_read - - &227 + - &233 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) @@ -35798,7 +35820,7 @@ paths: schema: type: string format: date-time - - &228 + - &234 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) @@ -35808,7 +35830,7 @@ paths: schema: type: string format: date-time - - &229 + - &235 name: token_id description: The ID of the token in: query @@ -35821,7 +35843,7 @@ paths: examples: - token_id[]=1,token_id[]=2 responses: - '500': *100 + '500': *98 '422': *15 '404': *6 '403': *27 @@ -35956,7 +35978,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35976,7 +35998,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: - - *99 + - *61 requestBody: required: true content: @@ -36018,7 +36040,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *100 + '500': *98 '422': *15 '404': *6 '403': *27 @@ -36043,7 +36065,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: - - *99 + - *61 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -36080,11 +36102,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *100 + '500': *98 '422': *15 '404': *6 '403': *27 - '204': *156 + '204': *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36105,7 +36127,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: - - *99 + - *61 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -36116,7 +36138,7 @@ paths: - *17 - *19 responses: - '500': *100 + '500': *98 '404': *6 '403': *27 '200': @@ -36125,11 +36147,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36150,19 +36172,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: - - *99 + - *61 - *17 - *19 - - *223 - - *46 - - *224 - - *225 - - *226 - - *227 - - *228 - *229 + - *46 + - *230 + - *231 + - *232 + - *233 + - *234 + - *235 responses: - '500': *100 + '500': *98 '422': *15 '404': *6 '403': *27 @@ -36291,7 +36313,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36311,7 +36333,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: - - *99 + - *61 requestBody: required: true content: @@ -36346,7 +36368,7 @@ paths: - 1296269 - 1296280 responses: - '500': *100 + '500': *98 '404': *6 '202': *37 '403': *27 @@ -36371,7 +36393,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: - - *99 + - *61 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -36399,9 +36421,9 @@ paths: value: action: revoke responses: - '500': *100 + '500': *98 '404': *6 - '204': *156 + '204': *165 '403': *27 '422': *15 x-github: @@ -36423,7 +36445,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: - - *99 + - *61 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -36433,7 +36455,7 @@ paths: - *17 - *19 responses: - '500': *100 + '500': *98 '404': *6 '403': *27 '200': @@ -36442,11 +36464,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36468,7 +36490,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *99 + - *61 - *17 - *19 responses: @@ -36486,7 +36508,7 @@ paths: type: integer configurations: type: array - items: &230 + items: &236 title: Organization private registry description: Private registry configuration for an organization type: object @@ -36555,7 +36577,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *57 + Link: *52 '400': *14 '404': *6 x-github: @@ -36577,7 +36599,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -36745,7 +36767,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &231 + org-private-registry-with-selected-visibility: &237 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -36786,7 +36808,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: - - *99 + - *61 responses: '200': description: Response @@ -36814,7 +36836,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -36836,16 +36858,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *99 - - *139 + - *61 + - *143 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *230 + schema: *236 examples: - default: *231 + default: *237 '404': *6 x-github: githubCloudOnly: false @@ -36866,8 +36888,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -36963,8 +36985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *99 - - *139 + - *61 + - *143 responses: '204': description: Response @@ -36989,7 +37011,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-organization-projects parameters: - - *99 + - *61 - name: state description: Indicates the state of the projects to return. in: query @@ -37010,7 +37032,7 @@ paths: application/json: schema: type: array - items: &232 + items: &238 title: Project description: Projects are a way to organize columns and cards of work. @@ -37143,7 +37165,7 @@ paths: organization_permission: write private: true headers: - Link: *57 + Link: *52 '422': *7 x-github: githubCloudOnly: false @@ -37166,7 +37188,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-an-organization-project parameters: - - *99 + - *61 requestBody: required: true content: @@ -37192,7 +37214,7 @@ paths: description: Response content: application/json: - schema: *232 + schema: *238 examples: default: value: @@ -37230,7 +37252,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &320 + '410': &315 description: Gone content: application/json: @@ -37256,7 +37278,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *99 + - *61 - name: q description: Limit results to projects of the specified type. in: query @@ -37273,7 +37295,7 @@ paths: application/json: schema: type: array - items: &233 + items: &239 title: Projects v2 Project description: A projects v2 project type: object @@ -37347,7 +37369,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &727 + - &731 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -37432,7 +37454,7 @@ paths: - deleted_at - deleted_by examples: - default: &234 + default: &240 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -37515,7 +37537,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -37535,24 +37557,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &235 + - &241 name: project_number description: The project's number. in: path required: true schema: type: integer - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: *233 + schema: *239 examples: - default: *234 + default: *240 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -37572,8 +37594,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *235 - - *99 + - *241 + - *61 - *17 - *38 - *39 @@ -37584,7 +37606,7 @@ paths: application/json: schema: type: array - items: &236 + items: &242 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -37734,7 +37756,7 @@ paths: - updated_at - project_url examples: - default: &237 + default: &243 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37757,7 +37779,7 @@ paths: created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -37777,25 +37799,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *235 - - &667 + - *241 + - &671 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: *236 + schema: *242 examples: - default: *237 + default: *243 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -37816,8 +37838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *235 - - *99 + - *241 + - *61 - 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. @@ -37826,17 +37848,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string - *38 - *39 - *17 @@ -37847,7 +37871,7 @@ paths: application/json: schema: type: array - items: &242 + items: &248 title: Projects v2 Item description: An item belonging to a project type: object @@ -37864,7 +37888,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: &240 + content_type: &246 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -37921,7 +37945,7 @@ paths: - updated_at - archived_at examples: - default: &243 + default: &249 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -38595,7 +38619,7 @@ paths: type: sub_issues_progress value: headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -38615,8 +38639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *99 - - *235 + - *61 + - *241 requestBody: required: true description: Details of the item to add to the project. @@ -38653,7 +38677,7 @@ paths: description: Response content: application/json: - schema: &668 + schema: &672 title: Projects v2 Item description: An item belonging to a project type: object @@ -38666,8 +38690,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *68 - - &447 + - *66 + - &442 title: Pull Request Simple description: Pull Request Simple type: object @@ -38787,7 +38811,7 @@ paths: milestone: anyOf: - type: 'null' - - *238 + - *244 active_lock_reason: type: - string @@ -38842,7 +38866,7 @@ paths: type: - array - 'null' - items: *161 + items: *169 head: type: object properties: @@ -38850,7 +38874,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *64 sha: type: string user: @@ -38870,7 +38894,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *64 sha: type: string user: @@ -38886,7 +38910,7 @@ paths: _links: type: object properties: - comments: &239 + comments: &245 title: Link description: Hypermedia Link type: object @@ -38895,13 +38919,13 @@ paths: type: string required: - href - commits: *239 - statuses: *239 - html: *239 - issue: *239 - review_comments: *239 - review_comment: *239 - self: *239 + commits: *245 + statuses: *245 + html: *245 + issue: *245 + review_comments: *245 + review_comment: *245 + self: *245 required: - comments - commits @@ -38911,8 +38935,8 @@ paths: - review_comments - review_comment - self - author_association: *69 - auto_merge: &544 + author_association: *67 + auto_merge: &541 title: Auto merge description: The status of auto merging a pull request. type: @@ -39014,7 +39038,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *240 + content_type: *246 creator: *4 created_at: type: string @@ -39051,7 +39075,7 @@ paths: - updated_at - archived_at examples: - issue: &241 + issue: &247 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -39106,7 +39130,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: *241 + pull_request: *247 '304': *35 '403': *27 '401': *23 @@ -39126,9 +39150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *235 - - *99 - - &244 + - *241 + - *61 + - &250 name: item_id description: The unique identifier of the project item. in: path @@ -39136,27 +39160,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *242 + schema: *248 examples: - default: *243 + default: *249 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -39175,9 +39201,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *235 - - *99 - - *244 + - *241 + - *61 + - *250 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -39250,13 +39276,13 @@ paths: description: Response content: application/json: - schema: *242 + schema: *248 examples: - text_field: *243 - number_field: *243 - date_field: *243 - single_select_field: *243 - iteration_field: *243 + text_field: *249 + number_field: *249 + date_field: *249 + single_select_field: *249 + iteration_field: *249 '401': *23 '403': *27 '404': *6 @@ -39276,9 +39302,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *235 - - *99 - - *244 + - *241 + - *61 + - *250 responses: '204': description: Response @@ -39302,7 +39328,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -39310,7 +39336,7 @@ paths: application/json: schema: type: array - items: &245 + items: &251 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -39386,7 +39412,7 @@ paths: - property_name - value_type examples: - default: &246 + default: &252 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -39434,7 +39460,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -39445,7 +39471,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *245 + items: *251 minItems: 1 maxItems: 100 required: @@ -39475,9 +39501,9 @@ paths: application/json: schema: type: array - items: *245 + items: *251 examples: - default: *246 + default: *252 '403': *27 '404': *6 x-github: @@ -39498,8 +39524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *99 - - &247 + - *61 + - &253 name: custom_property_name description: The custom property name in: path @@ -39511,9 +39537,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *251 examples: - default: &248 + default: &254 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -39547,8 +39573,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: - - *99 - - *247 + - *61 + - *253 requestBody: required: true content: @@ -39626,9 +39652,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *251 examples: - default: *248 + default: *254 '403': *27 '404': *6 x-github: @@ -39651,10 +39677,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *99 - - *247 + - *61 + - *253 responses: - '204': *156 + '204': *165 '403': *27 '404': *6 x-github: @@ -39675,7 +39701,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *99 + - *61 - *17 - *19 - name: repository_query @@ -39716,28 +39742,7 @@ paths: - octocat/Hello-World properties: type: array - items: &249 - 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 - type: - - 'null' - - string - - array - required: - - property_name - - value + items: *97 description: List of custom property names and associated values required: - repository_id @@ -39758,7 +39763,7 @@ paths: - property_name: team value: octocat headers: - Link: *57 + Link: *52 '403': *27 '404': *6 x-github: @@ -39786,7 +39791,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: - - *99 + - *61 requestBody: required: true content: @@ -39806,7 +39811,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *249 + items: *97 required: - repository_names - properties @@ -39847,7 +39852,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *99 + - *61 - *17 - *19 responses: @@ -39859,9 +39864,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39878,8 +39883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response if user is a public member @@ -39903,8 +39908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -39925,8 +39930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -39950,7 +39955,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *99 + - *61 - name: type description: Specifies the types of repositories you want returned. in: query @@ -39996,11 +40001,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40019,7 +40024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *99 + - *61 requestBody: required: true content: @@ -40201,7 +40206,7 @@ paths: description: Response content: application/json: - schema: &322 + schema: &317 title: Full Repository description: Full Repository type: object @@ -40547,7 +40552,7 @@ paths: template_repository: anyOf: - type: 'null' - - *66 + - *64 temp_clone_token: type: - string @@ -40647,13 +40652,13 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 organization: anyOf: - type: 'null' - *4 - parent: *66 - source: *66 + parent: *64 + source: *64 forks: type: integer master_branch: @@ -40666,7 +40671,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &452 + code_of_conduct: &447 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -40696,7 +40701,7 @@ paths: - key - name - html_url - security_and_analysis: *250 + security_and_analysis: *255 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -40780,7 +40785,7 @@ paths: - network_count - subscribers_count examples: - default: &324 + default: &319 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -41298,10 +41303,10 @@ paths: category: orgs subcategory: rules parameters: - - *99 + - *61 - *17 - *19 - - &567 + - &564 name: targets description: | A comma-separated list of rule targets to filter by. @@ -41320,7 +41325,7 @@ paths: application/json: schema: type: array - items: &276 + items: &281 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -41355,7 +41360,7 @@ paths: source: type: string description: The name of the source - enforcement: &253 + enforcement: &258 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -41368,7 +41373,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &254 + items: &259 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -41439,7 +41444,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &251 + - &256 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -41463,7 +41468,7 @@ paths: match. items: type: string - - &255 + - &260 title: Organization ruleset conditions type: object description: |- @@ -41477,7 +41482,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *251 + - *256 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -41511,7 +41516,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *251 + - *256 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -41533,7 +41538,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *251 + - *256 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -41546,7 +41551,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &252 + items: &257 title: Repository ruleset property targeting definition type: object @@ -41579,7 +41584,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *252 + items: *257 required: - repository_property type: @@ -41587,12 +41592,12 @@ paths: - object rules: type: array - items: &568 + items: &565 title: Repository Rule type: object description: A repository rule. oneOf: - - &256 + - &261 title: creation description: Only allow users with bypass permission to create matching refs. @@ -41604,7 +41609,7 @@ paths: type: string enum: - creation - - &257 + - &262 title: update description: Only allow users with bypass permission to update matching refs. @@ -41625,7 +41630,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &258 + - &263 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -41637,7 +41642,7 @@ paths: type: string enum: - deletion - - &259 + - &264 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -41649,7 +41654,7 @@ paths: type: string enum: - required_linear_history - - &565 + - &562 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -41727,7 +41732,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &260 + - &265 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -41751,7 +41756,7 @@ paths: type: string required: - required_deployment_environments - - &261 + - &266 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -41763,7 +41768,7 @@ paths: type: string enum: - required_signatures - - &262 + - &267 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -41825,7 +41830,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &263 + - &268 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -41873,7 +41878,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &264 + - &269 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -41885,7 +41890,7 @@ paths: type: string enum: - non_fast_forward - - &265 + - &270 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -41921,7 +41926,7 @@ paths: required: - operator - pattern - - &266 + - &271 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -41957,7 +41962,7 @@ paths: required: - operator - pattern - - &267 + - &272 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -41993,7 +41998,7 @@ paths: required: - operator - pattern - - &268 + - &273 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -42029,7 +42034,7 @@ paths: required: - operator - pattern - - &269 + - &274 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -42065,7 +42070,7 @@ paths: required: - operator - pattern - - &270 + - &275 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -42090,7 +42095,7 @@ paths: type: string required: - restricted_file_paths - - &271 + - &276 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -42114,7 +42119,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &272 + - &277 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -42137,7 +42142,7 @@ paths: type: string required: - restricted_file_extensions - - &273 + - &278 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -42162,7 +42167,7 @@ paths: maximum: 100 required: - max_file_size - - &274 + - &279 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -42212,7 +42217,7 @@ paths: - repository_id required: - workflows - - &275 + - &280 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -42273,7 +42278,7 @@ paths: - tool required: - code_scanning_tools - - &566 + - &563 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -42334,7 +42339,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *100 + '500': *98 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -42350,7 +42355,7 @@ paths: category: orgs subcategory: rules parameters: - - *99 + - *61 requestBody: description: Request body required: true @@ -42371,25 +42376,20 @@ paths: - push - repository default: branch - enforcement: *253 + enforcement: *258 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *254 - conditions: *255 + items: *259 + conditions: *260 rules: type: array description: An array of rules within the ruleset. - items: &278 + items: &283 title: Repository Rule type: object description: A repository rule. oneOf: - - *256 - - *257 - - *258 - - *259 - - *260 - *261 - *262 - *263 @@ -42405,6 +42405,11 @@ paths: - *273 - *274 - *275 + - *276 + - *277 + - *278 + - *279 + - *280 required: - name - enforcement @@ -42442,9 +42447,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: &277 + default: &282 value: id: 21 name: super cool ruleset @@ -42484,7 +42489,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *100 + '500': *98 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -42498,8 +42503,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *99 - - &569 + - *61 + - &566 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 @@ -42514,7 +42519,7 @@ paths: in: query schema: type: string - - &570 + - &567 name: time_period description: |- The time period to filter by. @@ -42530,14 +42535,14 @@ paths: - week - month default: day - - &571 + - &568 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 - - &572 + - &569 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -42557,7 +42562,7 @@ paths: description: Response content: application/json: - schema: &573 + schema: &570 title: Rule Suites description: Response type: array @@ -42613,7 +42618,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &574 + default: &571 value: - id: 21 actor_id: 12 @@ -42637,7 +42642,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42656,8 +42661,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *99 - - &575 + - *61 + - &572 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -42673,7 +42678,7 @@ paths: description: Response content: application/json: - schema: &576 + schema: &573 title: Rule Suite description: Response type: object @@ -42780,7 +42785,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &577 + default: &574 value: id: 21 actor_id: 12 @@ -42815,7 +42820,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42841,7 +42846,7 @@ paths: category: orgs subcategory: rules parameters: - - *99 + - *61 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42853,11 +42858,11 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *277 + default: *282 '404': *6 - '500': *100 + '500': *98 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -42873,7 +42878,7 @@ paths: category: orgs subcategory: rules parameters: - - *99 + - *61 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42899,16 +42904,16 @@ paths: - tag - push - repository - enforcement: *253 + enforcement: *258 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *254 - conditions: *255 + items: *259 + conditions: *260 rules: description: An array of rules within the ruleset. type: array - items: *278 + items: *283 examples: default: value: @@ -42943,11 +42948,11 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *277 + default: *282 '404': *6 - '500': *100 + '500': *98 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -42963,7 +42968,7 @@ paths: category: orgs subcategory: rules parameters: - - *99 + - *61 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42974,7 +42979,7 @@ paths: '204': description: Response '404': *6 - '500': *100 + '500': *98 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -42986,7 +42991,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *99 + - *61 - *17 - *19 - name: ruleset_id @@ -43002,7 +43007,7 @@ paths: application/json: schema: type: array - items: &279 + items: &284 title: Ruleset version type: object description: The historical version of a ruleset @@ -43026,7 +43031,7 @@ paths: type: string format: date-time examples: - default: &579 + default: &576 value: - version_id: 3 actor: @@ -43044,7 +43049,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43061,7 +43066,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *99 + - *61 - name: ruleset_id description: The ID of the ruleset. in: path @@ -43079,9 +43084,9 @@ paths: description: Response content: application/json: - schema: &580 + schema: &577 allOf: - - *279 + - *284 - type: object required: - state @@ -43128,7 +43133,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43150,15 +43155,53 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *99 - - *280 - - *281 - - *282 - - *283 + - *61 + - &578 + 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 + - &579 + 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 + - &580 + 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 + - &581 + 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 - *46 - *19 - *17 - - &581 + - &582 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 @@ -43168,7 +43211,7 @@ paths: required: false schema: type: string - - &582 + - &583 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 @@ -43178,10 +43221,42 @@ paths: required: false schema: type: string - - *284 - - *285 - - *286 - - *287 + - &584 + 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 + - &585 + 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 + - &586 + 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 + - &587 + 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 @@ -43189,13 +43264,615 @@ paths: application/json: schema: type: array - items: *288 + items: + type: object + properties: + number: *151 + created_at: *152 + updated_at: + anyOf: + - type: 'null' + - *153 + url: *154 + html_url: *155 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this + alert. + state: &588 + 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: &589 + type: + - string + - 'null' + description: "**Required when the `state` is `resolved`.** The + reason for resolving the alert." + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + - + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - *4 + 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: *51 + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected + secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - *4 + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in + ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection + bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + resolution_comment: + type: + - string + - 'null' + description: The comment that was optionally added when this + alert was closed + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple + repositories in the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert + is base64 encoded + first_location_detected: + anyOf: + - type: 'null' + - &590 + description: 'Details on the location where the token was + initially detected. This can be a commit, wiki commit, issue, + discussion, pull request. + + ' + oneOf: + - &592 + 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 + examples: + - "/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 + examples: + - 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 + examples: + - 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 + - &593 + 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 + examples: + - "/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 + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki + page + examples: + - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + examples: + - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki + commit + examples: + - 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 + - &594 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + - &595 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + - &596 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + - &597 + 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. + examples: + - https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + - &598 + 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. + examples: + - https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + - &599 + 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. + examples: + - https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + - &600 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + - &601 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + - &602 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + - &603 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + - &604 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + 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: + anyOf: + - type: 'null' + - *4 examples: - default: *289 + 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: *57 + Link: *52 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43220,7 +43897,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *99 + - *61 responses: '200': description: Response @@ -43232,7 +43909,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &291 + pattern_config_version: &286 type: - string - 'null' @@ -43242,7 +43919,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &290 + items: &285 type: object properties: token_type: @@ -43311,7 +43988,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *290 + items: *285 examples: default: value: @@ -43360,7 +44037,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *99 + - *61 requestBody: required: true content: @@ -43368,7 +44045,7 @@ paths: schema: type: object properties: - pattern_config_version: *291 + pattern_config_version: *286 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -43394,7 +44071,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *291 + custom_pattern_version: *286 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -43448,7 +44125,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *99 + - *61 - *46 - name: sort description: The property to sort the results by. @@ -43492,7 +44169,7 @@ paths: application/json: schema: type: array - items: &603 + items: &608 description: A repository security advisory. type: object properties: @@ -43736,7 +44413,7 @@ paths: login: type: string description: The username of the user credited. - type: *292 + type: *287 credits_detailed: type: - array @@ -43747,7 +44424,7 @@ paths: type: object properties: user: *4 - type: *292 + type: *287 state: type: string description: The state of the user's acceptance of the @@ -43773,7 +44450,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *161 + items: *169 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -43811,7 +44488,7 @@ paths: - private_fork additionalProperties: false examples: - default: &604 + default: &609 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -44190,7 +44867,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *99 + - *61 responses: '200': description: Response @@ -44198,9 +44875,9 @@ paths: application/json: schema: type: array - items: *214 + items: *220 examples: - default: *215 + default: *221 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44223,8 +44900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *99 - - *64 + - *61 + - *62 responses: '204': description: Response @@ -44249,8 +44926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *99 - - *64 + - *61 + - *62 responses: '204': description: Response @@ -44279,13 +44956,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &669 + schema: &673 type: object properties: total_minutes_used: @@ -44355,7 +45032,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &670 + default: &674 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -44385,13 +45062,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &671 + schema: &675 type: object properties: total_gigabytes_bandwidth_used: @@ -44409,7 +45086,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &672 + default: &676 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -44435,13 +45112,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &676 + schema: &680 type: object properties: days_left_in_billing_cycle: @@ -44459,7 +45136,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &677 + default: &681 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -44483,7 +45160,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Immutable releases settings response @@ -44533,7 +45210,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Response @@ -44591,7 +45268,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *99 + - *61 - *19 - *17 responses: @@ -44609,9 +45286,9 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: *143 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44630,7 +45307,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *99 + - *61 requestBody: required: true content: @@ -44679,8 +45356,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: - - *99 - - *120 + - *61 + - *124 responses: '204': description: Response @@ -44702,8 +45379,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: - - *99 - - *120 + - *61 + - *124 responses: '204': description: Response @@ -44726,7 +45403,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *99 + - *61 - *17 - *19 responses: @@ -44744,7 +45421,7 @@ paths: type: integer network_configurations: type: array - items: &293 + items: &288 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -44808,7 +45485,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44827,7 +45504,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: - - *99 + - *61 requestBody: required: true content: @@ -44869,9 +45546,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *288 examples: - default: &294 + default: &289 value: id: 123456789ABCDEF name: My network configuration @@ -44899,8 +45576,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: - - *99 - - &295 + - *61 + - &290 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -44912,11 +45589,11 @@ paths: description: Response content: application/json: - schema: *293 + schema: *288 examples: - default: *294 + default: *289 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44935,8 +45612,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: - - *99 - - *295 + - *61 + - *290 requestBody: required: true content: @@ -44975,9 +45652,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *288 examples: - default: *294 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44996,8 +45673,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: - - *99 - - *295 + - *61 + - *290 responses: '204': description: Response @@ -45020,7 +45697,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: - - *99 + - *61 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -45079,7 +45756,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: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45109,8 +45786,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *99 - - *64 + - *61 + - *62 - 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`). @@ -45142,13 +45819,13 @@ paths: application/json: schema: type: array - items: *296 + items: *291 examples: - default: *297 - '500': *100 + default: *292 + '500': *98 '403': *27 '404': *6 - '422': *298 + '422': *293 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45166,7 +45843,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *99 + - *61 - *17 - *19 responses: @@ -45176,11 +45853,11 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 headers: - Link: *57 + Link: *52 '403': *27 x-github: githubCloudOnly: false @@ -45200,7 +45877,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *99 + - *61 requestBody: required: true content: @@ -45272,7 +45949,7 @@ paths: description: Response content: application/json: - schema: &299 + schema: &294 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -45346,7 +46023,7 @@ paths: parent: anyOf: - type: 'null' - - *214 + - *220 members_count: type: integer examples: @@ -45671,7 +46348,7 @@ paths: - repos_count - organization examples: - default: &300 + default: &295 value: id: 1 node_id: MDQ6VGVhbTE= @@ -45741,16 +46418,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *99 - - *64 + - *61 + - *62 responses: '200': description: Response content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '404': *6 x-github: githubCloudOnly: false @@ -45771,8 +46448,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *99 - - *64 + - *61 + - *62 requestBody: required: false content: @@ -45835,16 +46512,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '201': description: Response content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '404': *6 '422': *15 '403': *27 @@ -45869,8 +46546,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *99 - - *64 + - *61 + - *62 responses: '204': description: Response @@ -45896,8 +46573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *99 - - *64 + - *61 + - *62 - *46 - *17 - *19 @@ -45914,7 +46591,7 @@ paths: application/json: schema: type: array - items: &301 + items: &296 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -46005,7 +46682,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *70 + reactions: *68 required: - author - body @@ -46025,7 +46702,7 @@ paths: - updated_at - url examples: - default: &621 + default: &626 value: - author: login: octocat @@ -46075,7 +46752,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46099,8 +46776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *99 - - *64 + - *61 + - *62 requestBody: required: true content: @@ -46134,9 +46811,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: &302 + default: &297 value: author: login: octocat @@ -46208,9 +46885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *99 - - *64 - - &303 + - *61 + - *62 + - &298 name: discussion_number description: The number that identifies the discussion. in: path @@ -46222,9 +46899,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: *302 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46246,9 +46923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 requestBody: required: false content: @@ -46271,9 +46948,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: &622 + default: &627 value: author: login: octocat @@ -46343,9 +47020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 responses: '204': description: Response @@ -46371,9 +47048,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 - *46 - *17 - *19 @@ -46384,7 +47061,7 @@ paths: application/json: schema: type: array - items: &304 + items: &299 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -46449,7 +47126,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *70 + reactions: *68 required: - author - body @@ -46464,7 +47141,7 @@ paths: - updated_at - url examples: - default: &623 + default: &628 value: - author: login: octocat @@ -46508,7 +47185,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46532,9 +47209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 requestBody: required: true content: @@ -46556,9 +47233,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: &305 + default: &300 value: author: login: octocat @@ -46624,10 +47301,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *99 - - *64 - - *303 - - &306 + - *61 + - *62 + - *298 + - &301 name: comment_number description: The number that identifies the comment. in: path @@ -46639,9 +47316,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: *305 + default: *300 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46663,10 +47340,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *99 - - *64 - - *303 - - *306 + - *61 + - *62 + - *298 + - *301 requestBody: required: true content: @@ -46688,9 +47365,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: &624 + default: &629 value: author: login: octocat @@ -46754,10 +47431,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *99 - - *64 - - *303 - - *306 + - *61 + - *62 + - *298 + - *301 responses: '204': description: Response @@ -46783,10 +47460,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *99 - - *64 - - *303 - - *306 + - *61 + - *62 + - *298 + - *301 - 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. @@ -46812,7 +47489,7 @@ paths: application/json: schema: type: array - items: &307 + items: &302 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -46856,7 +47533,7 @@ paths: - content - created_at examples: - default: &309 + default: &304 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -46882,7 +47559,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46906,10 +47583,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *99 - - *64 - - *303 - - *306 + - *61 + - *62 + - *298 + - *301 requestBody: required: true content: @@ -46942,9 +47619,9 @@ paths: team discussion comment content: application/json: - schema: *307 + schema: *302 examples: - default: &308 + default: &303 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -46973,9 +47650,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46998,11 +47675,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *99 - - *64 - - *303 - - *306 - - &310 + - *61 + - *62 + - *298 + - *301 + - &305 name: reaction_id description: The unique identifier of the reaction. in: path @@ -47034,9 +47711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 - 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. @@ -47062,11 +47739,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47090,9 +47767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 requestBody: required: true content: @@ -47124,16 +47801,16 @@ paths: description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47156,10 +47833,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *99 - - *64 - - *303 - - *310 + - *61 + - *62 + - *298 + - *305 responses: '204': description: Response @@ -47183,8 +47860,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *99 - - *64 + - *61 + - *62 - *17 - *19 responses: @@ -47194,11 +47871,11 @@ paths: application/json: schema: type: array - items: *196 + items: *202 examples: - default: *197 + default: *203 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47218,8 +47895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *99 - - *64 + - *61 + - *62 - name: role description: Filters members returned by their role in the team. in: query @@ -47242,9 +47919,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47272,15 +47949,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *99 - - *64 + - *61 - *62 + - *57 responses: '200': description: Response content: application/json: - schema: &311 + schema: &306 title: Team Membership description: Team Membership type: object @@ -47308,7 +47985,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &625 + response-if-user-is-a-team-maintainer: &630 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -47344,9 +48021,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *99 - - *64 + - *61 - *62 + - *57 requestBody: required: false content: @@ -47371,9 +48048,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *306 examples: - response-if-users-membership-with-team-is-now-pending: &626 + response-if-users-membership-with-team-is-now-pending: &631 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -47408,9 +48085,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *99 - - *64 + - *61 - *62 + - *57 responses: '204': description: Response @@ -47435,8 +48112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *99 - - *64 + - *61 + - *62 - *17 - *19 responses: @@ -47446,7 +48123,7 @@ paths: application/json: schema: type: array - items: &312 + items: &307 title: Team Project description: A team's access to a project. type: object @@ -47515,7 +48192,7 @@ paths: - updated_at - permissions examples: - default: &627 + default: &632 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -47555,7 +48232,7 @@ paths: write: true admin: false headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47578,9 +48255,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *99 - - *64 - - &313 + - *61 + - *62 + - &308 name: project_id description: The unique identifier of the project. in: path @@ -47592,9 +48269,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *307 examples: - default: &628 + default: &633 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -47656,9 +48333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *99 - - *64 - - *313 + - *61 + - *62 + - *308 requestBody: required: false content: @@ -47725,9 +48402,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *99 - - *64 - - *313 + - *61 + - *62 + - *308 responses: '204': description: Response @@ -47754,8 +48431,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *99 - - *64 + - *61 + - *62 - *17 - *19 responses: @@ -47765,11 +48442,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47796,16 +48473,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *99 - - *64 - - *314 - - *315 + - *61 + - *62 + - *309 + - *310 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &629 + schema: &634 title: Team Repository description: A team's access to a repository. type: object @@ -47831,7 +48508,7 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 forks: type: integer permissions: @@ -48446,10 +49123,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *99 - - *64 - - *314 - - *315 + - *61 + - *62 + - *309 + - *310 requestBody: required: false content: @@ -48494,10 +49171,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *99 - - *64 - - *314 - - *315 + - *61 + - *62 + - *309 + - *310 responses: '204': description: Response @@ -48521,8 +49198,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *99 - - *64 + - *61 + - *62 - *17 - *19 responses: @@ -48532,9 +49209,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - response-if-child-teams-exist: &630 + response-if-child-teams-exist: &635 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -48562,7 +49239,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48587,7 +49264,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *99 + - *61 - name: security_product in: path description: The security feature to enable or disable. @@ -48661,7 +49338,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column parameters: - - &316 + - &311 name: column_id description: The unique identifier of the column. in: path @@ -48673,7 +49350,7 @@ paths: description: Response content: application/json: - schema: &317 + schema: &312 title: Project Column description: Project columns contain cards of work. type: object @@ -48727,7 +49404,7 @@ paths: - created_at - updated_at examples: - default: &318 + default: &313 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -48762,7 +49439,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column parameters: - - *316 + - *311 requestBody: required: true content: @@ -48787,9 +49464,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: *318 + default: *313 '304': *35 '403': *27 '401': *23 @@ -48814,7 +49491,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column parameters: - - *316 + - *311 responses: '204': description: Response @@ -48843,7 +49520,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column parameters: - - *316 + - *311 requestBody: required: true content: @@ -48904,15 +49581,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#get-a-project parameters: - - *313 + - *308 responses: '200': description: Response content: application/json: - schema: *232 + schema: *238 examples: - default: &319 + default: &314 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -48969,7 +49646,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#update-a-project parameters: - - *313 + - *308 requestBody: required: false content: @@ -49018,9 +49695,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *238 examples: - default: *319 + default: *314 '404': description: Not Found if the authenticated user does not have access to the project @@ -49041,7 +49718,7 @@ paths: items: type: string '401': *23 - '410': *320 + '410': *315 '422': *7 x-github: githubCloudOnly: false @@ -49064,7 +49741,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#delete-a-project parameters: - - *313 + - *308 responses: '204': description: Delete Success @@ -49085,7 +49762,7 @@ paths: items: type: string '401': *23 - '410': *320 + '410': *315 '404': *6 x-github: githubCloudOnly: false @@ -49109,7 +49786,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators parameters: - - *313 + - *308 - 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 @@ -49136,9 +49813,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '404': *6 '422': *15 '304': *35 @@ -49166,8 +49843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator parameters: - - *313 - - *62 + - *308 + - *57 requestBody: required: false content: @@ -49221,8 +49898,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *313 - - *62 + - *308 + - *57 responses: '204': description: Response @@ -49253,8 +49930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *313 - - *62 + - *308 + - *57 responses: '200': description: Response @@ -49324,7 +50001,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#list-project-columns parameters: - - *313 + - *308 - *17 - *19 responses: @@ -49334,7 +50011,7 @@ paths: application/json: schema: type: array - items: *317 + items: *312 examples: default: value: @@ -49347,7 +50024,7 @@ paths: created_at: '2016-09-05T14:18:44Z' updated_at: '2016-09-05T14:22:28Z' headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -49372,7 +50049,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#create-a-project-column parameters: - - *313 + - *308 requestBody: required: true content: @@ -49396,7 +50073,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: default: value: @@ -49461,7 +50138,7 @@ paths: resources: type: object properties: - core: &321 + core: &316 title: Rate Limit type: object properties: @@ -49478,21 +50155,21 @@ paths: - remaining - reset - used - graphql: *321 - search: *321 - code_search: *321 - source_import: *321 - integration_manifest: *321 - code_scanning_upload: *321 - actions_runner_registration: *321 - scim: *321 - dependency_snapshots: *321 - dependency_sbom: *321 - code_scanning_autofix: *321 + graphql: *316 + search: *316 + code_search: *316 + source_import: *316 + integration_manifest: *316 + code_scanning_upload: *316 + actions_runner_registration: *316 + scim: *316 + dependency_snapshots: *316 + dependency_sbom: *316 + code_scanning_autofix: *316 required: - core - search - rate: *321 + rate: *316 required: - rate - resources @@ -49597,14 +50274,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *322 + schema: *317 examples: default-response: summary: Default response @@ -50105,7 +50782,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *323 + '301': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50123,8 +50800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -50372,10 +51049,10 @@ paths: description: Response content: application/json: - schema: *322 + schema: *317 examples: - default: *324 - '307': &325 + default: *319 + '307': &320 description: Temporary Redirect content: application/json: @@ -50404,8 +51081,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -50427,7 +51104,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *325 + '307': *320 '404': *6 '409': *45 x-github: @@ -50451,11 +51128,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 - - &356 + - &351 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50478,7 +51155,7 @@ paths: type: integer artifacts: type: array - items: &326 + items: &321 title: Artifact description: An artifact type: object @@ -50573,7 +51250,7 @@ paths: - expires_at - updated_at examples: - default: &357 + default: &352 value: total_count: 2 artifacts: @@ -50612,7 +51289,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50634,9 +51311,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *314 - - *315 - - &327 + - *309 + - *310 + - &322 name: artifact_id description: The unique identifier of the artifact. in: path @@ -50648,7 +51325,7 @@ paths: description: Response content: application/json: - schema: *326 + schema: *321 examples: default: value: @@ -50686,9 +51363,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *314 - - *315 - - *327 + - *309 + - *310 + - *322 responses: '204': description: Response @@ -50712,9 +51389,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *314 - - *315 - - *327 + - *309 + - *310 + - *322 - name: archive_format in: path required: true @@ -50728,7 +51405,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': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50751,14 +51428,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *328 + schema: *323 examples: default: value: @@ -50784,11 +51461,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 - - &329 + - &324 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 @@ -50822,7 +51499,7 @@ paths: description: Response content: application/json: - schema: &330 + schema: &325 title: Repository actions caches description: Repository actions caches type: object @@ -50872,7 +51549,7 @@ paths: - total_count - actions_caches examples: - default: &331 + default: &326 value: total_count: 1 actions_caches: @@ -50884,7 +51561,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50904,23 +51581,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: - - *314 - - *315 + - *309 + - *310 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *329 + - *324 responses: '200': description: Response content: application/json: - schema: *330 + schema: *325 examples: - default: *331 + default: *326 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50940,8 +51617,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: - - *314 - - *315 + - *309 + - *310 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -50972,9 +51649,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *314 - - *315 - - &332 + - *309 + - *310 + - &327 name: job_id description: The unique identifier of the job. in: path @@ -50986,7 +51663,7 @@ paths: description: Response content: application/json: - schema: &360 + schema: &355 title: Job description: Information of a job execution in a workflow run type: object @@ -51333,9 +52010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *314 - - *315 - - *332 + - *309 + - *310 + - *327 responses: '302': description: Response @@ -51363,9 +52040,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *314 - - *315 - - *332 + - *309 + - *310 + - *327 requestBody: required: false content: @@ -51387,7 +52064,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -51411,8 +52088,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Status response @@ -51462,8 +52139,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -51497,7 +52174,7 @@ paths: description: Empty response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -51526,8 +52203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -51545,7 +52222,7 @@ paths: type: integer secrets: type: array - items: &362 + items: &357 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -51566,7 +52243,7 @@ paths: - created_at - updated_at examples: - default: &363 + default: &358 value: total_count: 2 secrets: @@ -51577,7 +52254,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51599,9 +52276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *314 - - *315 - - *333 + - *309 + - *310 + - *328 - *19 responses: '200': @@ -51618,7 +52295,7 @@ paths: type: integer variables: type: array - items: &366 + items: &361 title: Actions Variable type: object properties: @@ -51652,7 +52329,7 @@ paths: - created_at - updated_at examples: - default: &367 + default: &362 value: total_count: 2 variables: @@ -51665,7 +52342,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51685,8 +52362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -51695,12 +52372,12 @@ paths: schema: type: object properties: - enabled: &335 + enabled: &330 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *116 - selected_actions_url: *334 - sha_pinning_required: *117 + allowed_actions: *120 + selected_actions_url: *329 + sha_pinning_required: *121 required: - enabled examples: @@ -51728,8 +52405,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -51740,9 +52417,9 @@ paths: schema: type: object properties: - enabled: *335 - allowed_actions: *116 - sha_pinning_required: *117 + enabled: *330 + allowed_actions: *120 + sha_pinning_required: *121 required: - enabled examples: @@ -51772,14 +52449,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &336 + schema: &331 type: object properties: access_level: @@ -51796,7 +52473,7 @@ paths: required: - access_level examples: - default: &337 + default: &332 value: access_level: organization x-github: @@ -51820,15 +52497,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: application/json: - schema: *336 + schema: *331 examples: - default: *337 + default: *332 responses: '204': description: Response @@ -51852,14 +52529,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *338 + schema: *333 examples: default: value: @@ -51883,8 +52560,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Empty response for successful settings update @@ -51894,7 +52571,7 @@ paths: required: true content: application/json: - schema: *339 + schema: *334 examples: default: summary: Set retention days @@ -51918,16 +52595,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *118 + schema: *122 examples: - default: *340 + default: *335 '404': *6 x-github: enabledForGitHubApps: true @@ -51946,8 +52623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -51957,7 +52634,7 @@ paths: required: true content: application/json: - schema: *118 + schema: *122 examples: default: summary: Set approval policy to first time contributors @@ -51981,16 +52658,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *341 + schema: *336 examples: - default: *119 + default: *123 '403': *27 '404': *6 x-github: @@ -52010,15 +52687,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: application/json: - schema: *342 + schema: *337 examples: - default: *119 + default: *123 responses: '204': description: Empty response for successful settings update @@ -52042,16 +52719,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *121 + schema: *125 examples: - default: *122 + default: *126 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52070,8 +52747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -52079,9 +52756,9 @@ paths: required: false content: application/json: - schema: *121 + schema: *125 examples: - selected_actions: *122 + selected_actions: *126 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52103,16 +52780,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *343 + schema: *338 examples: - default: *126 + default: *130 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52133,8 +52810,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Success response @@ -52145,9 +52822,9 @@ paths: required: true content: application/json: - schema: *344 + schema: *339 examples: - default: *126 + default: *130 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52174,8 +52851,8 @@ paths: in: query schema: type: string - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -52193,11 +52870,11 @@ paths: type: integer runners: type: array - items: *133 + items: *137 examples: - default: *134 + default: *138 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52219,8 +52896,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -52228,9 +52905,9 @@ paths: application/json: schema: type: array - items: *345 + items: *340 examples: - default: *346 + default: *341 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52252,8 +52929,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -52296,7 +52973,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *347 + '201': *342 '404': *6 '422': *7 '409': *45 @@ -52327,16 +53004,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '201': description: Response content: application/json: - schema: *135 + schema: *139 examples: - default: *348 + default: *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52364,16 +53041,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '201': description: Response content: application/json: - schema: *135 + schema: *139 examples: - default: *349 + default: *344 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52395,17 +53072,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 responses: '200': description: Response content: application/json: - schema: *133 + schema: *137 examples: - default: *350 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52426,9 +53103,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 responses: '204': description: Response @@ -52454,11 +53131,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 responses: - '200': *137 + '200': *141 '404': *6 x-github: githubCloudOnly: false @@ -52480,9 +53157,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 requestBody: required: true content: @@ -52506,7 +53183,7 @@ paths: - gpu - accelerated responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -52530,9 +53207,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 requestBody: required: true content: @@ -52557,7 +53234,7 @@ paths: - gpu - accelerated responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -52581,11 +53258,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 responses: - '200': *351 + '200': *346 '404': *6 x-github: githubCloudOnly: false @@ -52612,12 +53289,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: - - *314 - - *315 - - *132 - - *352 + - *309 + - *310 + - *136 + - *347 responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -52643,9 +53320,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *314 - - *315 - - &370 + - *309 + - *310 + - &365 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. @@ -52653,7 +53330,7 @@ paths: required: false schema: type: string - - &371 + - &366 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -52661,7 +53338,7 @@ paths: required: false schema: type: string - - &372 + - &367 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -52670,7 +53347,7 @@ paths: required: false schema: type: string - - &373 + - &368 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 @@ -52697,7 +53374,7 @@ paths: - pending - *17 - *19 - - &374 + - &369 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)." @@ -52706,7 +53383,7 @@ paths: schema: type: string format: date-time - - &353 + - &348 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -52715,13 +53392,13 @@ paths: schema: type: boolean default: false - - &375 + - &370 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &376 + - &371 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -52744,7 +53421,7 @@ paths: type: integer workflow_runs: type: array - items: &354 + items: &349 title: Workflow Run description: An invocation of a workflow type: object @@ -52861,7 +53538,7 @@ paths: type: - array - 'null' - items: *72 + items: *70 created_at: type: string format: date-time @@ -52922,7 +53599,7 @@ paths: head_commit: anyOf: - type: 'null' - - &398 + - &393 title: Simple Commit description: A commit. type: object @@ -52996,8 +53673,8 @@ paths: - timestamp - author - committer - repository: *131 - head_repository: *131 + repository: *135 + head_repository: *135 head_repository_id: type: integer examples: @@ -53037,7 +53714,7 @@ paths: - workflow_url - pull_requests examples: - default: &377 + default: &372 value: total_count: 1 workflow_runs: @@ -53251,7 +53928,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: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53273,24 +53950,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *314 - - *315 - - &355 + - *309 + - *310 + - &350 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *353 + - *348 responses: '200': description: Response content: application/json: - schema: *354 + schema: *349 examples: - default: &358 + default: &353 value: id: 30433642 name: Build @@ -53531,9 +54208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '204': description: Response @@ -53556,9 +54233,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '200': description: Response @@ -53686,15 +54363,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: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '201': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -53721,12 +54398,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 - *17 - *19 - - *356 + - *351 responses: '200': description: Response @@ -53742,11 +54419,11 @@ paths: type: integer artifacts: type: array - items: *326 + items: *321 examples: - default: *357 + default: *352 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53768,25 +54445,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *314 - - *315 - - *355 - - &359 + - *309 + - *310 + - *350 + - &354 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *353 + - *348 responses: '200': description: Response content: application/json: - schema: *354 + schema: *349 examples: - default: *358 + default: *353 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53809,10 +54486,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *314 - - *315 - - *355 - - *359 + - *309 + - *310 + - *350 + - *354 - *17 - *19 responses: @@ -53830,9 +54507,9 @@ paths: type: integer jobs: type: array - items: *360 + items: *355 examples: - default: &361 + default: &356 value: total_count: 1 jobs: @@ -53921,7 +54598,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -53945,10 +54622,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *314 - - *315 - - *355 - - *359 + - *309 + - *310 + - *350 + - *354 responses: '302': description: Response @@ -53976,15 +54653,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '202': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -54011,9 +54688,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: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 requestBody: required: true content: @@ -54080,15 +54757,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '202': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -54115,9 +54792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 - 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 @@ -54147,11 +54824,11 @@ paths: type: integer jobs: type: array - items: *360 + items: *355 examples: - default: *361 + default: *356 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54174,9 +54851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '302': description: Response @@ -54203,14 +54880,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '204': description: Response '403': *27 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54232,9 +54909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '200': description: Response @@ -54303,7 +54980,7 @@ paths: items: type: object properties: - type: &472 + type: &467 type: string description: The type of reviewer. enum: @@ -54314,7 +54991,7 @@ paths: reviewer: anyOf: - *4 - - *161 + - *169 required: - environment - wait_timer @@ -54389,9 +55066,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 requestBody: required: true content: @@ -54441,7 +55118,7 @@ paths: application/json: schema: type: array - items: &467 + items: &462 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -54553,7 +55230,7 @@ paths: - created_at - updated_at examples: - default: &468 + default: &463 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -54609,9 +55286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 requestBody: required: false content: @@ -54633,7 +55310,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -54656,9 +55333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 requestBody: required: false content: @@ -54680,7 +55357,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -54712,9 +55389,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '200': description: Response @@ -54851,8 +55528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -54870,11 +55547,11 @@ paths: type: integer secrets: type: array - items: *362 + items: *357 examples: - default: *363 + default: *358 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54897,16 +55574,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *364 + schema: *359 examples: - default: *365 + default: *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54928,17 +55605,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '200': description: Response content: application/json: - schema: *362 + schema: *357 examples: - default: &485 + default: &480 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -54964,9 +55641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 requestBody: required: true content: @@ -54997,7 +55674,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -55023,9 +55700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '204': description: Response @@ -55050,9 +55727,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *314 - - *315 - - *333 + - *309 + - *310 + - *328 - *19 responses: '200': @@ -55069,11 +55746,11 @@ paths: type: integer variables: type: array - items: *366 + items: *361 examples: - default: *367 + default: *362 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55094,8 +55771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -55122,7 +55799,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -55147,17 +55824,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *314 - - *315 - - *142 + - *309 + - *310 + - *146 responses: '200': description: Response content: application/json: - schema: *366 + schema: *361 examples: - default: &486 + default: &481 value: name: USERNAME value: octocat @@ -55183,9 +55860,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *314 - - *315 - - *142 + - *309 + - *310 + - *146 requestBody: required: true content: @@ -55227,9 +55904,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *314 - - *315 - - *142 + - *309 + - *310 + - *146 responses: '204': description: Response @@ -55254,8 +55931,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -55273,7 +55950,7 @@ paths: type: integer workflows: type: array - items: &368 + items: &363 title: Workflow description: A GitHub Actions workflow type: object @@ -55368,7 +56045,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: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55391,9 +56068,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *314 - - *315 - - &369 + - *309 + - *310 + - &364 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -55408,7 +56085,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *363 examples: default: value: @@ -55441,9 +56118,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *314 - - *315 - - *369 + - *309 + - *310 + - *364 responses: '204': description: Response @@ -55468,9 +56145,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *314 - - *315 - - *369 + - *309 + - *310 + - *364 responses: '204': description: Response @@ -55521,9 +56198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *314 - - *315 - - *369 + - *309 + - *310 + - *364 responses: '204': description: Response @@ -55550,19 +56227,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *314 - - *315 + - *309 + - *310 + - *364 + - *365 + - *366 + - *367 + - *368 + - *17 + - *19 - *369 + - *348 - *370 - *371 - - *372 - - *373 - - *17 - - *19 - - *374 - - *353 - - *375 - - *376 responses: '200': description: Response @@ -55578,11 +56255,11 @@ paths: type: integer workflow_runs: type: array - items: *354 + items: *349 examples: - default: *377 + default: *372 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55612,9 +56289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *314 - - *315 - - *369 + - *309 + - *310 + - *364 responses: '200': description: Response @@ -55675,8 +56352,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *314 - - *315 + - *309 + - *310 - *46 - *17 - *38 @@ -55825,7 +56502,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 '422': *7 x-github: githubCloudOnly: false @@ -55844,8 +56521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -55857,9 +56534,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -55882,8 +56559,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *314 - - *315 + - *309 + - *310 - name: assignee in: path required: true @@ -55919,8 +56596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -56032,8 +56709,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *38 - *39 @@ -56089,7 +56766,7 @@ paths: initiator: type: string examples: - default: *378 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56109,8 +56786,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -56118,7 +56795,7 @@ paths: application/json: schema: type: array - items: &379 + items: &374 title: Autolink reference description: An autolink reference. type: object @@ -56177,8 +56854,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -56217,9 +56894,9 @@ paths: description: response content: application/json: - schema: *379 + schema: *374 examples: - default: &380 + default: &375 value: id: 1 key_prefix: TICKET- @@ -56250,9 +56927,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *314 - - *315 - - &381 + - *309 + - *310 + - &376 name: autolink_id description: The unique identifier of the autolink. in: path @@ -56264,9 +56941,9 @@ paths: description: Response content: application/json: - schema: *379 + schema: *374 examples: - default: *380 + default: *375 '404': *6 x-github: githubCloudOnly: false @@ -56286,9 +56963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *314 - - *315 - - *381 + - *309 + - *310 + - *376 responses: '204': description: Response @@ -56312,8 +56989,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response if Dependabot is enabled @@ -56363,8 +57040,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -56385,8 +57062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -56406,8 +57083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *314 - - *315 + - *309 + - *310 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -56445,7 +57122,7 @@ paths: - url protected: type: boolean - protection: &383 + protection: &378 title: Branch Protection description: Branch Protection type: object @@ -56488,7 +57165,7 @@ paths: required: - contexts - checks - enforce_admins: &386 + enforce_admins: &381 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -56505,7 +57182,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &388 + required_pull_request_reviews: &383 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -56527,7 +57204,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *161 + items: *169 apps: description: The list of apps with review dismissal access. @@ -56559,7 +57236,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *161 + items: *169 apps: description: The list of apps allowed to bypass pull request requirements. @@ -56589,7 +57266,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &385 + restrictions: &380 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -56652,7 +57329,7 @@ paths: type: string teams: type: array - items: *161 + items: *169 apps: type: array items: @@ -56864,7 +57541,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -56882,9 +57559,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *314 - - *315 - - &384 + - *309 + - *310 + - &379 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). @@ -56898,14 +57575,14 @@ paths: description: Response content: application/json: - schema: &394 + schema: &389 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &443 + commit: &438 title: Commit description: Commit type: object @@ -56944,7 +57621,7 @@ paths: author: anyOf: - type: 'null' - - &382 + - &377 title: Git User description: Metaproperties for Git author/committer information. @@ -56965,7 +57642,7 @@ paths: committer: anyOf: - type: 'null' - - *382 + - *377 message: type: string examples: @@ -56989,7 +57666,7 @@ paths: required: - sha - url - verification: &492 + verification: &487 title: Verification type: object properties: @@ -57025,14 +57702,14 @@ paths: author: oneOf: - *4 - - *140 + - *144 type: - 'null' - object committer: oneOf: - *4 - - *140 + - *144 type: - 'null' - object @@ -57069,7 +57746,7 @@ paths: type: integer files: type: array - items: &454 + items: &449 title: Diff Entry description: Diff Entry type: object @@ -57165,7 +57842,7 @@ paths: - self protected: type: boolean - protection: *383 + protection: *378 protection_url: type: string format: uri @@ -57274,7 +57951,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *323 + '301': *318 '404': *6 x-github: githubCloudOnly: false @@ -57296,15 +57973,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *383 + schema: *378 examples: default: value: @@ -57498,9 +58175,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -57760,7 +58437,7 @@ paths: url: type: string format: uri - required_status_checks: &391 + required_status_checks: &386 title: Status Check Policy description: Status Check Policy type: object @@ -57841,7 +58518,7 @@ paths: items: *4 teams: type: array - items: *161 + items: *169 apps: type: array items: *5 @@ -57859,7 +58536,7 @@ paths: items: *4 teams: type: array - items: *161 + items: *169 apps: type: array items: *5 @@ -57919,7 +58596,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *385 + restrictions: *380 required_conversation_resolution: type: object properties: @@ -58031,9 +58708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58058,17 +58735,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *386 + schema: *381 examples: - default: &387 + default: &382 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -58090,17 +58767,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *386 + schema: *381 examples: - default: *387 + default: *382 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58119,9 +58796,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58146,17 +58823,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *388 + schema: *383 examples: - default: &389 + default: &384 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -58252,9 +58929,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -58352,9 +59029,9 @@ paths: description: Response content: application/json: - schema: *388 + schema: *383 examples: - default: *389 + default: *384 '422': *15 x-github: githubCloudOnly: false @@ -58375,9 +59052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58404,17 +59081,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *386 + schema: *381 examples: - default: &390 + default: &385 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -58437,17 +59114,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *386 + schema: *381 examples: - default: *390 + default: *385 '404': *6 x-github: githubCloudOnly: false @@ -58467,9 +59144,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58494,17 +59171,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *391 + schema: *386 examples: - default: &392 + default: &387 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -58530,9 +59207,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -58584,9 +59261,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *386 examples: - default: *392 + default: *387 '404': *6 '422': *15 x-github: @@ -58608,9 +59285,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58634,9 +59311,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response @@ -58670,9 +59347,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -58739,9 +59416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -58805,9 +59482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: content: application/json: @@ -58873,15 +59550,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *385 + schema: *380 examples: default: value: @@ -58972,9 +59649,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58997,9 +59674,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response @@ -59009,7 +59686,7 @@ paths: type: array items: *5 examples: - default: &393 + default: &388 value: - id: 1 slug: octoapp @@ -59066,9 +59743,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59102,7 +59779,7 @@ paths: type: array items: *5 examples: - default: *393 + default: *388 '422': *15 x-github: githubCloudOnly: false @@ -59123,9 +59800,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59159,7 +59836,7 @@ paths: type: array items: *5 examples: - default: *393 + default: *388 '422': *15 x-github: githubCloudOnly: false @@ -59180,9 +59857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59216,7 +59893,7 @@ paths: type: array items: *5 examples: - default: *393 + default: *388 '422': *15 x-github: githubCloudOnly: false @@ -59238,9 +59915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response @@ -59248,9 +59925,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 '404': *6 x-github: githubCloudOnly: false @@ -59270,9 +59947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -59308,9 +59985,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 '422': *15 x-github: githubCloudOnly: false @@ -59331,9 +60008,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -59369,9 +60046,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 '422': *15 x-github: githubCloudOnly: false @@ -59392,9 +60069,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: content: application/json: @@ -59429,9 +60106,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 '422': *15 x-github: githubCloudOnly: false @@ -59453,9 +60130,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response @@ -59465,7 +60142,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 '404': *6 x-github: githubCloudOnly: false @@ -59489,9 +60166,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59524,7 +60201,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 '422': *15 x-github: githubCloudOnly: false @@ -59549,9 +60226,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59584,7 +60261,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 '422': *15 x-github: githubCloudOnly: false @@ -59609,9 +60286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59644,7 +60321,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 '422': *15 x-github: githubCloudOnly: false @@ -59671,9 +60348,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59695,7 +60372,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *389 examples: default: value: @@ -59811,8 +60488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -60091,7 +60768,7 @@ paths: description: Response content: application/json: - schema: &395 + schema: &390 title: CheckRun description: A check performed on the code of a given code change type: object @@ -60226,8 +60903,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *72 - deployment: &688 + items: *70 + deployment: &692 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -60514,9 +61191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *314 - - *315 - - &396 + - *309 + - *310 + - &391 name: check_run_id description: The unique identifier of the check run. in: path @@ -60528,9 +61205,9 @@ paths: description: Response content: application/json: - schema: *395 + schema: *390 examples: - default: &397 + default: &392 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -60630,9 +61307,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *314 - - *315 - - *396 + - *309 + - *310 + - *391 requestBody: required: true content: @@ -60872,9 +61549,9 @@ paths: description: Response content: application/json: - schema: *395 + schema: *390 examples: - default: *397 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60894,9 +61571,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *314 - - *315 - - *396 + - *309 + - *310 + - *391 - *17 - *19 responses: @@ -60986,7 +61663,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: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61006,15 +61683,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *314 - - *315 - - *396 + - *309 + - *310 + - *391 responses: '201': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -61052,8 +61729,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -61075,7 +61752,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &399 + schema: &394 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -61157,12 +61834,12 @@ paths: type: - array - 'null' - items: *72 + items: *70 app: anyOf: - type: 'null' - *5 - repository: *131 + repository: *135 created_at: type: - string @@ -61173,7 +61850,7 @@ paths: - string - 'null' format: date-time - head_commit: *398 + head_commit: *393 latest_check_runs_count: type: integer check_runs_url: @@ -61201,7 +61878,7 @@ paths: - check_runs_url - pull_requests examples: - default: &400 + default: &395 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -61492,9 +62169,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *399 + schema: *394 examples: - default: *400 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61513,8 +62190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -61575,7 +62252,7 @@ paths: required: - app_id - setting - repository: *131 + repository: *135 examples: default: value: @@ -61823,9 +62500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *314 - - *315 - - &401 + - *309 + - *310 + - &396 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -61837,9 +62514,9 @@ paths: description: Response content: application/json: - schema: *399 + schema: *394 examples: - default: *400 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61862,17 +62539,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *314 - - *315 - - *401 - - &449 + - *309 + - *310 + - *396 + - &444 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &450 + - &445 name: status description: Returns check runs with the specified `status`. in: query @@ -61911,9 +62588,9 @@ paths: type: integer check_runs: type: array - items: *395 + items: *390 examples: - default: &451 + default: &446 value: total_count: 1 check_runs: @@ -61995,7 +62672,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62015,15 +62692,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *314 - - *315 - - *401 + - *309 + - *310 + - *396 responses: '201': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -62050,21 +62727,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *314 - - *315 - - *402 - - *403 + - *309 + - *310 + - *397 + - *398 - *19 - *17 - - &420 + - &415 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: *404 - - &421 + schema: *399 + - &416 name: pr description: The number of the pull request for the results you want to list. in: query @@ -62089,13 +62766,13 @@ paths: be returned. in: query required: false - schema: *405 + schema: *400 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *406 + schema: *401 responses: '200': description: Response @@ -62106,24 +62783,24 @@ paths: items: type: object properties: - number: *52 - created_at: *53 - updated_at: *54 - url: *55 - html_url: *56 - instances_url: *407 - state: *151 - fixed_at: *147 + number: *151 + created_at: *152 + updated_at: *153 + url: *154 + html_url: *155 + instances_url: *402 + state: *160 + fixed_at: *156 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *148 - dismissed_reason: *408 - dismissed_comment: *409 - rule: *410 - tool: *411 - most_recent_instance: *412 + dismissed_at: *157 + dismissed_reason: *403 + dismissed_comment: *404 + rule: *405 + tool: *406 + most_recent_instance: *407 dismissal_approved_by: anyOf: - type: 'null' @@ -62246,14 +62923,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &413 + '403': &408 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62273,9 +62950,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *314 - - *315 - - &414 + - *309 + - *310 + - &409 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -62283,30 +62960,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *52 + schema: *151 responses: '200': description: Response content: application/json: - schema: &415 + schema: &410 type: object properties: - number: *52 - created_at: *53 - updated_at: *54 - url: *55 - html_url: *56 - instances_url: *407 - state: *151 - fixed_at: *147 + number: *151 + created_at: *152 + updated_at: *153 + url: *154 + html_url: *155 + instances_url: *402 + state: *160 + fixed_at: *156 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *148 - dismissed_reason: *408 - dismissed_comment: *409 + dismissed_at: *157 + dismissed_reason: *403 + dismissed_comment: *404 rule: type: object properties: @@ -62368,8 +63045,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *411 - most_recent_instance: *412 + tool: *406 + most_recent_instance: *407 dismissal_approved_by: anyOf: - type: 'null' @@ -62465,9 +63142,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62485,9 +63162,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 requestBody: required: true content: @@ -62502,8 +63179,8 @@ paths: enum: - open - dismissed - dismissed_reason: *408 - dismissed_comment: *409 + dismissed_reason: *403 + dismissed_comment: *404 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -62522,7 +63199,7 @@ paths: description: Response content: application/json: - schema: *415 + schema: *410 examples: default: value: @@ -62598,14 +63275,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &419 + '403': &414 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': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62625,15 +63302,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: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 responses: '200': description: Response content: application/json: - schema: &416 + schema: &411 type: object properties: status: @@ -62660,13 +63337,13 @@ paths: - description - started_at examples: - default: &417 + default: &412 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &418 + '400': &413 description: Bad Request content: application/json: @@ -62677,9 +63354,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': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62702,29 +63379,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: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 responses: '200': description: OK content: application/json: - schema: *416 + schema: *411 examples: - default: *417 + default: *412 '202': description: Accepted content: application/json: - schema: *416 + schema: *411 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *418 + '400': *413 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -62734,7 +63411,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62756,9 +63433,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: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 requestBody: required: false content: @@ -62804,12 +63481,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *418 - '403': *419 + '400': *413 + '403': *414 '404': *6 '422': description: Unprocessable Entity - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62829,13 +63506,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 - *19 - *17 - - *420 - - *421 + - *415 + - *416 responses: '200': description: Response @@ -62843,7 +63520,7 @@ paths: application/json: schema: type: array - items: *412 + items: *407 examples: default: value: @@ -62882,9 +63559,9 @@ paths: end_column: 50 classifications: - source - '403': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62916,25 +63593,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *314 - - *315 - - *402 - - *403 + - *309 + - *310 + - *397 + - *398 - *19 - *17 - - *421 + - *416 - 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: *404 + schema: *399 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &424 + schema: &419 type: string description: An identifier for the upload. examples: @@ -62956,23 +63633,23 @@ paths: application/json: schema: type: array - items: &425 + items: &420 type: object properties: - ref: *404 - commit_sha: &433 + ref: *399 + commit_sha: &428 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: *422 + analysis_key: *417 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *423 + category: *418 error: type: string examples: @@ -62997,8 +63674,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *424 - tool: *411 + sarif_id: *419 + tool: *406 deletable: type: boolean warning: @@ -63060,9 +63737,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63096,8 +63773,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: - - *314 - - *315 + - *309 + - *310 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63110,7 +63787,7 @@ paths: description: Response content: application/json: - schema: *425 + schema: *420 examples: response: summary: application/json response @@ -63164,14 +63841,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *413 + '403': *408 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63251,8 +63928,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: - - *314 - - *315 + - *309 + - *310 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63308,9 +63985,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': *419 + '403': *414 '404': *6 - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63330,8 +64007,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -63339,7 +64016,7 @@ paths: application/json: schema: type: array - items: &426 + items: &421 title: CodeQL Database description: A CodeQL database. type: object @@ -63451,9 +64128,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': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63480,8 +64157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - name: language in: path description: The language of the CodeQL database. @@ -63493,7 +64170,7 @@ paths: description: Response content: application/json: - schema: *426 + schema: *421 examples: default: value: @@ -63525,11 +64202,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': &456 + '302': &451 description: Found - '403': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63549,8 +64226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *314 - - *315 + - *309 + - *310 - name: language in: path description: The language of the CodeQL database. @@ -63560,9 +64237,9 @@ paths: responses: '204': description: Response - '403': *419 + '403': *414 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63588,8 +64265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -63598,7 +64275,7 @@ paths: type: object additionalProperties: false properties: - language: &427 + language: &422 type: string description: The language targeted by the CodeQL query enum: @@ -63677,7 +64354,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &431 + schema: &426 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -63687,7 +64364,7 @@ paths: description: The ID of the variant analysis. controller_repo: *51 actor: *4 - query_language: *427 + query_language: *422 query_pack_url: type: string description: The download url for the query pack. @@ -63735,7 +64412,7 @@ paths: items: type: object properties: - repository: &428 + repository: &423 title: Repository Identifier description: Repository Identifier type: object @@ -63777,7 +64454,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &432 + analysis_status: &427 type: string description: The new status of the CodeQL variant analysis repository task. @@ -63809,7 +64486,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &429 + access_mismatch_repos: &424 type: object properties: repository_count: @@ -63824,7 +64501,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: *428 + items: *423 required: - repository_count - repositories @@ -63847,8 +64524,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *429 - over_limit_repos: *429 + no_codeql_db_repos: *424 + over_limit_repos: *424 required: - access_mismatch_repos - not_found_repos @@ -63864,7 +64541,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &430 + value: &425 summary: Default response value: id: 1 @@ -64016,17 +64693,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *430 + value: *425 repository_lists: summary: Response for a successful variant analysis submission - value: *430 + value: *425 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64047,8 +64724,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: - - *314 - - *315 + - *309 + - *310 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -64060,11 +64737,11 @@ paths: description: Response content: application/json: - schema: *431 + schema: *426 examples: - default: *430 + default: *425 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64085,7 +64762,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: - - *314 + - *309 - name: repo in: path description: The name of the controller repository. @@ -64120,7 +64797,7 @@ paths: type: object properties: repository: *51 - analysis_status: *432 + analysis_status: *427 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -64224,7 +64901,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64245,8 +64922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -64339,9 +65016,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64360,8 +65037,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -64430,7 +65107,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -64455,7 +65132,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *419 + '403': *414 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -64469,7 +65146,7 @@ paths: content: application/json: schema: *3 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64526,8 +65203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -64535,7 +65212,7 @@ paths: schema: type: object properties: - commit_sha: *433 + commit_sha: *428 ref: type: string description: |- @@ -64595,7 +65272,7 @@ paths: schema: type: object properties: - id: *424 + id: *419 url: type: string description: The REST API URL for checking the status of the upload. @@ -64609,11 +65286,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': *419 + '403': *414 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64632,8 +65309,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *314 - - *315 + - *309 + - *310 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -64681,10 +65358,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': *413 + '403': *408 '404': description: Not Found if the sarif id does not match any upload - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64706,8 +65383,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -64763,7 +65440,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': *156 + '204': *165 '304': *35 '403': *27 '404': *6 @@ -64788,8 +65465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *314 - - *315 + - *309 + - *310 - 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 @@ -64917,8 +65594,8 @@ paths: parameters: - *17 - *19 - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -64934,7 +65611,7 @@ paths: type: integer codespaces: type: array - items: *204 + items: *210 examples: default: value: @@ -65210,7 +65887,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': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -65232,8 +65909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -65297,22 +65974,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65336,8 +66013,8 @@ paths: parameters: - *17 - *19 - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -65377,7 +66054,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *100 + '500': *98 '400': *14 '401': *23 '403': *27 @@ -65401,8 +66078,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -65439,9 +66116,9 @@ paths: type: integer machines: type: array - items: *435 + items: *430 examples: - default: &637 + default: &642 value: total_count: 2 machines: @@ -65458,7 +66135,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -65481,8 +66158,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *314 - - *315 + - *309 + - *310 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -65569,8 +66246,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: - - *314 - - *315 + - *309 + - *310 - 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 @@ -65618,7 +66295,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65639,8 +66316,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -65658,7 +66335,7 @@ paths: type: integer secrets: type: array - items: &439 + items: &434 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -65679,9 +66356,9 @@ paths: - created_at - updated_at examples: - default: *436 + default: *431 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65702,16 +66379,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *437 + schema: *432 examples: - default: *438 + default: *433 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65731,17 +66408,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '200': description: Response content: application/json: - schema: *439 + schema: *434 examples: - default: *440 + default: *435 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65761,9 +66438,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 requestBody: required: true content: @@ -65791,7 +66468,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -65815,9 +66492,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '204': description: Response @@ -65845,8 +66522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *314 - - *315 + - *309 + - *310 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -65884,7 +66561,7 @@ paths: application/json: schema: type: array - items: &441 + items: &436 title: Collaborator description: Collaborator type: object @@ -66052,7 +66729,7 @@ paths: admin: false role_name: write headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -66077,9 +66754,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *314 - - *315 - - *62 + - *309 + - *310 + - *57 responses: '204': description: Response if user is a collaborator @@ -66125,9 +66802,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *314 - - *315 - - *62 + - *309 + - *310 + - *57 requestBody: required: false content: @@ -66153,7 +66830,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &505 + schema: &500 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -66165,7 +66842,7 @@ paths: format: int64 examples: - 42 - repository: *131 + repository: *135 invitee: anyOf: - type: 'null' @@ -66341,7 +67018,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *105 + schema: *104 '403': *27 x-github: triggersNotification: true @@ -66381,9 +67058,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *314 - - *315 - - *62 + - *309 + - *310 + - *57 responses: '204': description: No Content when collaborator was removed from the repository. @@ -66414,9 +67091,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *314 - - *315 - - *62 + - *309 + - *310 + - *57 responses: '200': description: if user has admin permissions @@ -66436,7 +67113,7 @@ paths: user: anyOf: - type: 'null' - - *441 + - *436 required: - permission - role_name @@ -66490,8 +67167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -66501,7 +67178,7 @@ paths: application/json: schema: type: array - items: &442 + items: &437 title: Commit Comment description: Commit Comment type: object @@ -66542,8 +67219,8 @@ paths: updated_at: type: string format: date-time - author_association: *69 - reactions: *70 + author_association: *67 + reactions: *68 required: - url - html_url @@ -66559,7 +67236,7 @@ paths: - created_at - updated_at examples: - default: &445 + default: &440 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66593,7 +67270,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66618,17 +67295,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '200': description: Response content: application/json: - schema: *442 + schema: *437 examples: - default: &446 + default: &441 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66685,9 +67362,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -66709,7 +67386,7 @@ paths: description: Response content: application/json: - schema: *442 + schema: *437 examples: default: value: @@ -66760,9 +67437,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '204': description: Response @@ -66783,9 +67460,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 - 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. @@ -66811,11 +67488,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -66834,9 +67511,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -66868,16 +67545,16 @@ paths: description: Reaction exists content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Reaction created content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -66899,10 +67576,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *314 - - *315 - - *84 + - *309 - *310 + - *81 + - *305 responses: '204': description: Response @@ -66951,8 +67628,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *314 - - *315 + - *309 + - *310 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -67008,9 +67685,9 @@ paths: application/json: schema: type: array - items: *443 + items: *438 examples: - default: &551 + default: &548 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67080,8 +67757,8 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *57 - '500': *100 + Link: *52 + '500': *98 '400': *14 '404': *6 '409': *45 @@ -67104,9 +67781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *314 - - *315 - - &444 + - *309 + - *310 + - &439 name: commit_sha description: The SHA of the commit. in: path @@ -67178,9 +67855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *314 - - *315 - - *444 + - *309 + - *310 + - *439 - *17 - *19 responses: @@ -67190,11 +67867,11 @@ paths: application/json: schema: type: array - items: *442 + items: *437 examples: - default: *445 + default: *440 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67220,9 +67897,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *314 - - *315 - - *444 + - *309 + - *310 + - *439 requestBody: required: true content: @@ -67257,9 +67934,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *437 examples: - default: *446 + default: *441 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67287,9 +67964,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *314 - - *315 - - *444 + - *309 + - *310 + - *439 - *17 - *19 responses: @@ -67299,9 +67976,9 @@ paths: application/json: schema: type: array - items: *447 + items: *442 examples: - default: &543 + default: &540 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -67780,7 +68457,7 @@ paths: auto_merge: draft: false headers: - Link: *57 + Link: *52 '409': *45 x-github: githubCloudOnly: false @@ -67838,11 +68515,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *314 - - *315 + - *309 + - *310 - *19 - *17 - - &448 + - &443 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)" @@ -67857,9 +68534,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *438 examples: - default: &531 + default: &526 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67945,8 +68622,8 @@ paths: ..... '422': *15 '404': *6 - '500': *100 - '503': *73 + '500': *98 + '503': *99 '409': *45 x-github: githubCloudOnly: false @@ -67972,11 +68649,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *314 - - *315 - - *448 - - *449 - - *450 + - *309 + - *310 + - *443 + - *444 + - *445 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -68010,11 +68687,11 @@ paths: type: integer check_runs: type: array - items: *395 + items: *390 examples: - default: *451 + default: *446 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68037,9 +68714,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *314 - - *315 - - *448 + - *309 + - *310 + - *443 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -68047,7 +68724,7 @@ paths: schema: type: integer example: 1 - - *449 + - *444 - *17 - *19 responses: @@ -68065,7 +68742,7 @@ paths: type: integer check_suites: type: array - items: *399 + items: *394 examples: default: value: @@ -68240,7 +68917,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: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68265,9 +68942,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *314 - - *315 - - *448 + - *309 + - *310 + - *443 - *17 - *19 responses: @@ -68338,7 +69015,7 @@ paths: type: string total_count: type: integer - repository: *131 + repository: *135 commit_url: type: string format: uri @@ -68469,9 +69146,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *314 - - *315 - - *448 + - *309 + - *310 + - *443 - *17 - *19 responses: @@ -68481,7 +69158,7 @@ paths: application/json: schema: type: array - items: &608 + items: &613 title: Status description: The status of a commit. type: object @@ -68561,8 +69238,8 @@ paths: type: User site_admin: false headers: - Link: *57 - '301': *323 + Link: *52 + '301': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68590,8 +69267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -68624,11 +69301,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *452 + - *447 code_of_conduct_file: anyOf: - type: 'null' - - &453 + - &448 title: Community Health File type: object properties: @@ -68644,23 +69321,23 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 contributing: anyOf: - type: 'null' - - *453 + - *448 readme: anyOf: - type: 'null' - - *453 + - *448 issue_template: anyOf: - type: 'null' - - *453 + - *448 pull_request_template: anyOf: - type: 'null' - - *453 + - *448 required: - code_of_conduct - code_of_conduct_file @@ -68789,8 +69466,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *314 - - *315 + - *309 + - *310 - *19 - *17 - name: basehead @@ -68838,8 +69515,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *443 - merge_base_commit: *443 + base_commit: *438 + merge_base_commit: *438 status: type: string enum: @@ -68863,10 +69540,10 @@ paths: - 6 commits: type: array - items: *443 + items: *438 files: type: array - items: *454 + items: *449 required: - url - html_url @@ -69109,8 +69786,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69152,8 +69829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *314 - - *315 + - *309 + - *310 - name: path description: path parameter in: path @@ -69306,7 +69983,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &455 + response-if-content-is-a-file: &450 summary: Response if content is a file value: type: file @@ -69443,7 +70120,7 @@ paths: - size - type - url - - &556 + - &553 title: Content File description: Content File type: object @@ -69661,7 +70338,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *455 + response-if-content-is-a-file: *450 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -69730,7 +70407,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *456 + '302': *451 '304': *35 x-github: githubCloudOnly: false @@ -69753,8 +70430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *314 - - *315 + - *309 + - *310 - name: path description: path parameter in: path @@ -69849,7 +70526,7 @@ paths: description: Response content: application/json: - schema: &457 + schema: &452 title: File Commit description: File Commit type: object @@ -70005,7 +70682,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *452 examples: example-for-creating-a-file: value: @@ -70059,7 +70736,7 @@ paths: schema: oneOf: - *3 - - &487 + - &482 description: Repository rule violation was detected type: object properties: @@ -70080,7 +70757,7 @@ paths: items: type: object properties: - placeholder_id: &600 + placeholder_id: &605 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -70112,8 +70789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *314 - - *315 + - *309 + - *310 - name: path description: path parameter in: path @@ -70174,7 +70851,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *452 examples: default: value: @@ -70209,7 +70886,7 @@ paths: '422': *15 '404': *6 '409': *45 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70229,8 +70906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *314 - - *315 + - *309 + - *310 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -70331,7 +71008,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *57 + Link: *52 '204': description: Response if repository is empty '403': *27 @@ -70354,31 +71031,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *314 - - *315 - - *162 - - *163 - - *164 - - *165 + - *309 + - *310 + - *170 + - *171 + - *172 + - *173 - 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 - - *166 - - *458 - - *167 - - *168 + - *174 + - *453 + - *175 + - *176 - *46 - - 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)." @@ -70389,8 +71058,6 @@ paths: default: 30 - *38 - *39 - - *169 - - *170 responses: '200': description: Response @@ -70398,11 +71065,11 @@ paths: application/json: schema: type: array - items: &461 + items: &456 type: object description: A Dependabot alert. properties: - number: *52 + number: *151 state: type: string description: The state of the Dependabot alert. @@ -70448,13 +71115,13 @@ paths: - direct - transitive - - security_advisory: *459 + security_advisory: *454 security_vulnerability: *50 - url: *55 - html_url: *56 - created_at: *53 - updated_at: *54 - dismissed_at: *148 + url: *154 + html_url: *155 + created_at: *152 + updated_at: *153 + dismissed_at: *157 dismissed_by: anyOf: - type: 'null' @@ -70478,8 +71145,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *147 - auto_dismissed_at: *460 + fixed_at: *156 + auto_dismissed_at: *455 required: - number - state @@ -70709,9 +71376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *314 - - *315 - - &462 + - *309 + - *310 + - &457 name: alert_number in: path description: |- @@ -70720,13 +71387,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *52 + schema: *151 responses: '200': description: Response content: application/json: - schema: *461 + schema: *456 examples: default: value: @@ -70839,9 +71506,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *314 - - *315 - - *462 + - *309 + - *310 + - *457 requestBody: required: true content: @@ -70886,7 +71553,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *456 examples: default: value: @@ -71015,8 +71682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -71034,7 +71701,7 @@ paths: type: integer secrets: type: array - items: &465 + items: &460 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -71066,7 +71733,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71088,16 +71755,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *463 + schema: *458 examples: - default: *464 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71117,15 +71784,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '200': description: Response content: application/json: - schema: *465 + schema: *460 examples: default: value: @@ -71151,9 +71818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 requestBody: required: true content: @@ -71181,7 +71848,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -71205,9 +71872,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '204': description: Response @@ -71229,8 +71896,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: - - *314 - - *315 + - *309 + - *310 - 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 @@ -71380,7 +72047,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *57 + Link: *52 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -71404,8 +72071,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -71642,7 +72309,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *57 + Link: *52 '404': *6 '403': *27 x-github: @@ -71665,8 +72332,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -71749,7 +72416,7 @@ paths: - version - url additionalProperties: false - metadata: &466 + metadata: &461 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -71788,7 +72455,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *466 + metadata: *461 resolved: type: object description: A collection of resolved package dependencies. @@ -71802,7 +72469,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *466 + metadata: *461 relationship: type: string description: A notation of whether a dependency is requested @@ -71935,8 +72602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *314 - - *315 + - *309 + - *310 - name: sha description: The SHA recorded at creation time. in: query @@ -71977,11 +72644,11 @@ paths: application/json: schema: type: array - items: *467 + items: *462 examples: - default: *468 + default: *463 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72045,8 +72712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -72128,7 +72795,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *462 examples: simple-example: summary: Simple example @@ -72201,9 +72868,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *314 - - *315 - - &469 + - *309 + - *310 + - &464 name: deployment_id description: deployment_id parameter in: path @@ -72215,7 +72882,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *462 examples: default: value: @@ -72280,9 +72947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *314 - - *315 - - *469 + - *309 + - *310 + - *464 responses: '204': description: Response @@ -72304,9 +72971,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *314 - - *315 - - *469 + - *309 + - *310 + - *464 - *17 - *19 responses: @@ -72316,7 +72983,7 @@ paths: application/json: schema: type: array - items: &470 + items: &465 title: Deployment Status description: The status of a deployment. type: object @@ -72460,7 +73127,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -72480,9 +73147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *314 - - *315 - - *469 + - *309 + - *310 + - *464 requestBody: required: true content: @@ -72557,9 +73224,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *465 examples: - default: &471 + default: &466 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -72615,9 +73282,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *314 - - *315 - - *469 + - *309 + - *310 + - *464 - name: status_id in: path required: true @@ -72628,9 +73295,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *465 examples: - default: *471 + default: *466 '404': *6 x-github: githubCloudOnly: false @@ -72655,8 +73322,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -72713,8 +73380,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -72732,7 +73399,7 @@ paths: - 5 environments: type: array - items: &473 + items: &468 title: Environment description: Details of a deployment environment type: object @@ -72794,7 +73461,7 @@ paths: type: string examples: - wait_timer - wait_timer: &475 + wait_timer: &470 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -72836,11 +73503,11 @@ paths: items: type: object properties: - type: *472 + type: *467 reviewer: anyOf: - *4 - - *161 + - *169 required: - id - node_id @@ -72863,7 +73530,7 @@ paths: - id - node_id - type - deployment_branch_policy: &476 + deployment_branch_policy: &471 type: - object - 'null' @@ -72980,9 +73647,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *314 - - *315 - - &474 + - *309 + - *310 + - &469 name: environment_name in: path required: true @@ -72995,9 +73662,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *468 examples: - default: &477 + default: &472 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -73081,9 +73748,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 requestBody: required: false content: @@ -73093,7 +73760,7 @@ paths: - object - 'null' properties: - wait_timer: *475 + wait_timer: *470 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -73112,14 +73779,14 @@ paths: items: type: object properties: - type: *472 + type: *467 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *476 + deployment_branch_policy: *471 additionalProperties: false examples: default: @@ -73139,9 +73806,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *468 examples: - default: *477 + default: *472 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -73165,9 +73832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 responses: '204': description: Default response @@ -73192,9 +73859,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 - *17 - *19 responses: @@ -73213,7 +73880,7 @@ paths: - 2 branch_policies: type: array - items: &478 + items: &473 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -73274,9 +73941,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 requestBody: required: true content: @@ -73324,9 +73991,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: - example-wildcard: &479 + example-wildcard: &474 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -73368,10 +74035,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *314 - - *315 - - *474 - - &480 + - *309 + - *310 + - *469 + - &475 name: branch_policy_id in: path required: true @@ -73383,9 +74050,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: - default: *479 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73404,10 +74071,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *314 - - *315 - - *474 - - *480 + - *309 + - *310 + - *469 + - *475 requestBody: required: true content: @@ -73436,9 +74103,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: - default: *479 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73457,10 +74124,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *314 - - *315 - - *474 - - *480 + - *309 + - *310 + - *469 + - *475 responses: '204': description: Response @@ -73485,9 +74152,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *474 - - *315 - - *314 + - *469 + - *310 + - *309 responses: '200': description: List of deployment protection rules @@ -73504,7 +74171,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &481 + items: &476 title: Deployment protection rule description: Deployment protection rule type: object @@ -73526,7 +74193,7 @@ paths: for the environment. examples: - true - app: &482 + app: &477 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -73629,9 +74296,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: - - *474 - - *315 - - *314 + - *469 + - *310 + - *309 requestBody: content: application/json: @@ -73652,9 +74319,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *481 + schema: *476 examples: - default: &483 + default: &478 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -73689,9 +74356,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: - - *474 - - *315 - - *314 + - *469 + - *310 + - *309 - *19 - *17 responses: @@ -73711,7 +74378,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *482 + items: *477 examples: default: value: @@ -73746,10 +74413,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *314 - - *315 - - *474 - - &484 + - *309 + - *310 + - *469 + - &479 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -73761,9 +74428,9 @@ paths: description: Response content: application/json: - schema: *481 + schema: *476 examples: - default: *483 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73784,10 +74451,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *474 - - *315 - - *314 - - *484 + - *469 + - *310 + - *309 + - *479 responses: '204': description: Response @@ -73813,9 +74480,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 - *17 - *19 responses: @@ -73833,11 +74500,11 @@ paths: type: integer secrets: type: array - items: *362 + items: *357 examples: - default: *363 + default: *358 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73860,17 +74527,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 responses: '200': description: Response content: application/json: - schema: *364 + schema: *359 examples: - default: *365 + default: *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73892,18 +74559,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *314 - - *315 - - *474 - - *139 + - *309 + - *310 + - *469 + - *143 responses: '200': description: Response content: application/json: - schema: *362 + schema: *357 examples: - default: *485 + default: *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73925,10 +74592,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *314 - - *315 - - *474 - - *139 + - *309 + - *310 + - *469 + - *143 requestBody: required: true content: @@ -73959,7 +74626,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -73985,10 +74652,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *314 - - *315 - - *474 - - *139 + - *309 + - *310 + - *469 + - *143 responses: '204': description: Default response @@ -74013,10 +74680,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *314 - - *315 - - *474 - - *333 + - *309 + - *310 + - *469 + - *328 - *19 responses: '200': @@ -74033,11 +74700,11 @@ paths: type: integer variables: type: array - items: *366 + items: *361 examples: - default: *367 + default: *362 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74058,9 +74725,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 requestBody: required: true content: @@ -74087,7 +74754,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -74112,18 +74779,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *314 - - *315 - - *474 - - *142 + - *309 + - *310 + - *469 + - *146 responses: '200': description: Response content: application/json: - schema: *366 + schema: *361 examples: - default: *486 + default: *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74144,10 +74811,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *314 - - *315 - - *142 - - *474 + - *309 + - *310 + - *146 + - *469 requestBody: required: true content: @@ -74189,10 +74856,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *314 - - *315 - - *142 - - *474 + - *309 + - *310 + - *146 + - *469 responses: '204': description: Response @@ -74214,8 +74881,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -74225,7 +74892,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: 200-response: value: @@ -74283,8 +74950,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *314 - - *315 + - *309 + - *310 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -74306,7 +74973,7 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: default: value: @@ -74419,7 +75086,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *57 + Link: *52 '400': *14 x-github: githubCloudOnly: false @@ -74443,8 +75110,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -74477,9 +75144,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *317 examples: - default: *324 + default: *319 '400': *14 '422': *15 '403': *27 @@ -74500,8 +75167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -74560,8 +75227,8 @@ paths: application/json: schema: oneOf: - - *105 - - *487 + - *104 + - *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74586,8 +75253,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *314 - - *315 + - *309 + - *310 - name: file_sha in: path required: true @@ -74687,8 +75354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -74797,7 +75464,7 @@ paths: description: Response content: application/json: - schema: &488 + schema: &483 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -75024,15 +75691,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *314 - - *315 - - *444 + - *309 + - *310 + - *439 responses: '200': description: Response content: application/json: - schema: *488 + schema: *483 examples: default: value: @@ -75088,9 +75755,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *314 - - *315 - - &489 + - *309 + - *310 + - &484 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. @@ -75107,7 +75774,7 @@ paths: application/json: schema: type: array - items: &490 + items: &485 title: Git Reference description: Git references within a repository type: object @@ -75161,7 +75828,7 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *57 + Link: *52 '409': *45 x-github: githubCloudOnly: false @@ -75183,17 +75850,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *314 - - *315 - - *489 + - *309 + - *310 + - *484 responses: '200': description: Response content: application/json: - schema: *490 + schema: *485 examples: - default: &491 + default: &486 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -75222,8 +75889,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -75252,9 +75919,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *485 examples: - default: *491 + default: *486 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -75280,9 +75947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *314 - - *315 - - *489 + - *309 + - *310 + - *484 requestBody: required: true content: @@ -75311,9 +75978,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *485 examples: - default: *491 + default: *486 '422': *15 '409': *45 x-github: @@ -75331,9 +75998,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *314 - - *315 - - *489 + - *309 + - *310 + - *484 responses: '204': description: Response @@ -75388,8 +76055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -75456,7 +76123,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &488 title: Git Tag description: Metadata for a Git tag type: object @@ -75512,7 +76179,7 @@ paths: - sha - type - url - verification: *492 + verification: *487 required: - sha - url @@ -75522,7 +76189,7 @@ paths: - tag - message examples: - default: &494 + default: &489 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -75595,8 +76262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *314 - - *315 + - *309 + - *310 - name: tag_sha in: path required: true @@ -75607,9 +76274,9 @@ paths: description: Response content: application/json: - schema: *493 + schema: *488 examples: - default: *494 + default: *489 '404': *6 '409': *45 x-github: @@ -75633,8 +76300,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -75708,7 +76375,7 @@ paths: description: Response content: application/json: - schema: &495 + schema: &490 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -75810,8 +76477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *314 - - *315 + - *309 + - *310 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -75834,7 +76501,7 @@ paths: description: Response content: application/json: - schema: *495 + schema: *490 examples: default-response: summary: Default response @@ -75893,8 +76560,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -75904,7 +76571,7 @@ paths: application/json: schema: type: array - items: &496 + items: &491 title: Webhook description: Webhooks for repositories. type: object @@ -75967,7 +76634,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &719 + last_response: &723 title: Hook Response type: object properties: @@ -76025,7 +76692,7 @@ paths: status: unused message: headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -76044,8 +76711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -76098,9 +76765,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *491 examples: - default: &497 + default: &492 value: type: Repository id: 12345678 @@ -76148,17 +76815,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 responses: '200': description: Response content: application/json: - schema: *496 + schema: *491 examples: - default: *497 + default: *492 '404': *6 x-github: githubCloudOnly: false @@ -76178,9 +76845,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 requestBody: required: true content: @@ -76225,9 +76892,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *491 examples: - default: *497 + default: *492 '422': *15 '404': *6 x-github: @@ -76248,9 +76915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 responses: '204': description: Response @@ -76274,9 +76941,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 responses: '200': description: Response @@ -76303,9 +76970,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 requestBody: required: false content: @@ -76349,11 +77016,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 - *17 - - *177 + - *183 responses: '200': description: Response @@ -76361,9 +77028,9 @@ paths: application/json: schema: type: array - items: *178 + items: *184 examples: - default: *179 + default: *185 '400': *14 '422': *15 x-github: @@ -76382,18 +77049,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 - *16 responses: '200': description: Response content: application/json: - schema: *180 + schema: *186 examples: - default: *181 + default: *187 '400': *14 '422': *15 x-github: @@ -76412,9 +77079,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 - *16 responses: '202': *37 @@ -76437,9 +77104,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 responses: '204': description: Response @@ -76464,9 +77131,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 responses: '204': description: Response @@ -76489,8 +77156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response if immutable releases are enabled @@ -76538,10 +77205,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *314 - - *315 + - *309 + - *310 responses: - '204': *156 + '204': *165 '409': *45 x-github: githubCloudOnly: false @@ -76559,10 +77226,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *314 - - *315 + - *309 + - *310 responses: - '204': *156 + '204': *165 '409': *45 x-github: githubCloudOnly: false @@ -76617,14 +77284,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &498 + schema: &493 title: Import description: A repository import from an external source. type: object @@ -76731,7 +77398,7 @@ paths: - html_url - authors_url examples: - default: &501 + default: &496 value: vcs: subversion use_lfs: true @@ -76747,7 +77414,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': &499 + '503': &494 description: Unavailable due to service under maintenance. content: application/json: @@ -76776,8 +77443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -76825,7 +77492,7 @@ paths: description: Response content: application/json: - schema: *498 + schema: *493 examples: default: value: @@ -76850,7 +77517,7 @@ paths: type: string '422': *15 '404': *6 - '503': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76878,8 +77545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -76931,7 +77598,7 @@ paths: description: Response content: application/json: - schema: *498 + schema: *493 examples: example-1: summary: Example 1 @@ -76979,7 +77646,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': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77002,12 +77669,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response - '503': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77033,9 +77700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *314 - - *315 - - &659 + - *309 + - *310 + - &663 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -77049,7 +77716,7 @@ paths: application/json: schema: type: array - items: &500 + items: &495 title: Porter Author description: Porter Author type: object @@ -77103,7 +77770,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': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77128,8 +77795,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *314 - - *315 + - *309 + - *310 - name: author_id in: path required: true @@ -77159,7 +77826,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *495 examples: default: value: @@ -77172,7 +77839,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77196,8 +77863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -77238,7 +77905,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77266,8 +77933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -77294,11 +77961,11 @@ paths: description: Response content: application/json: - schema: *498 + schema: *493 examples: - default: *501 + default: *496 '422': *15 - '503': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77321,8 +77988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -77330,8 +77997,8 @@ paths: application/json: schema: *20 examples: - default: *502 - '301': *323 + default: *497 + '301': *318 '404': *6 x-github: githubCloudOnly: false @@ -77351,8 +78018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -77360,12 +78027,12 @@ paths: application/json: schema: anyOf: - - *194 + - *200 - type: object properties: {} additionalProperties: false examples: - default: &504 + default: &499 value: limit: collaborators_only origin: repository @@ -77390,13 +78057,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: application/json: - schema: *503 + schema: *498 examples: default: summary: Example request body @@ -77408,9 +78075,9 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: - default: *504 + default: *499 '409': description: Response x-github: @@ -77432,8 +78099,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -77456,8 +78123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -77467,9 +78134,9 @@ paths: application/json: schema: type: array - items: *505 + items: *500 examples: - default: &652 + default: &656 value: - id: 1 repository: @@ -77583,7 +78250,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77600,9 +78267,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *314 - - *315 - - *198 + - *309 + - *310 + - *204 requestBody: required: false content: @@ -77631,7 +78298,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *500 examples: default: value: @@ -77762,9 +78429,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *314 - - *315 - - *198 + - *309 + - *310 + - *204 responses: '204': description: Response @@ -77795,8 +78462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *314 - - *315 + - *309 + - *310 - 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 @@ -77844,7 +78511,7 @@ paths: required: false schema: type: string - - *202 + - *208 - name: sort description: What to sort results by. in: query @@ -77857,7 +78524,7 @@ paths: - comments default: created - *46 - - *75 + - *72 - *17 - *19 responses: @@ -77867,9 +78534,9 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: &512 + default: &507 value: - id: 1 node_id: MDU6SXNzdWUx @@ -78016,8 +78683,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *57 - '301': *323 + Link: *52 + '301': *318 '422': *15 '404': *6 x-github: @@ -78046,8 +78713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -78137,9 +78804,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: &509 + default: &504 value: id: 1 node_id: MDU6SXNzdWUx @@ -78293,9 +78960,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *73 + '503': *99 '404': *6 - '410': *320 + '410': *315 x-github: triggersNotification: true githubCloudOnly: false @@ -78323,9 +78990,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *314 - - *315 - - *92 + - *309 + - *310 + - *89 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -78335,7 +79002,7 @@ paths: enum: - asc - desc - - *75 + - *72 - *17 - *19 responses: @@ -78345,9 +79012,9 @@ paths: application/json: schema: type: array - items: *506 + items: *501 examples: - default: &511 + default: &506 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78378,7 +79045,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *57 + Link: *52 '422': *15 '404': *6 x-github: @@ -78405,17 +79072,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '200': description: Response content: application/json: - schema: *506 + schema: *501 examples: - default: &507 + default: &502 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78469,9 +79136,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -78493,9 +79160,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *501 examples: - default: *507 + default: *502 '422': *15 x-github: githubCloudOnly: false @@ -78513,9 +79180,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '204': description: Response @@ -78535,9 +79202,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 - 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. @@ -78563,11 +79230,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -78586,9 +79253,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -78620,16 +79287,16 @@ paths: description: Reaction exists content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Reaction created content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -78651,10 +79318,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *314 - - *315 - - *84 + - *309 - *310 + - *81 + - *305 responses: '204': description: Response @@ -78674,8 +79341,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -78685,7 +79352,7 @@ paths: application/json: schema: type: array - items: &508 + items: &503 title: Issue Event description: Issue Event type: object @@ -78732,7 +79399,7 @@ paths: issue: anyOf: - type: 'null' - - *68 + - *66 label: title: Issue Event Label description: Issue Event Label @@ -78765,7 +79432,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *161 + requested_team: *169 dismissed_review: title: Issue Event Dismissed Review type: object @@ -78832,7 +79499,7 @@ paths: required: - from - to - author_association: *69 + author_association: *67 lock_reason: type: - string @@ -79006,7 +79673,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *57 + Link: *52 '422': *15 x-github: githubCloudOnly: false @@ -79024,8 +79691,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *314 - - *315 + - *309 + - *310 - name: event_id in: path required: true @@ -79036,7 +79703,7 @@ paths: description: Response content: application/json: - schema: *508 + schema: *503 examples: default: value: @@ -79229,7 +79896,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *320 + '410': *315 '403': *27 x-github: githubCloudOnly: false @@ -79263,9 +79930,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *314 - - *315 - - &510 + - *309 + - *310 + - &505 name: issue_number description: The number that identifies the issue. in: path @@ -79277,12 +79944,12 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 - '301': *323 + default: *504 + '301': *318 '404': *6 - '410': *320 + '410': *315 '304': *35 x-github: githubCloudOnly: false @@ -79307,9 +79974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: false content: @@ -79428,15 +80095,15 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 '422': *15 - '503': *73 + '503': *99 '403': *27 - '301': *323 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79454,9 +80121,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: false content: @@ -79482,9 +80149,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79500,9 +80167,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: content: application/json: @@ -79527,9 +80194,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79551,9 +80218,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: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - name: assignee in: path required: true @@ -79593,10 +80260,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *314 - - *315 - - *510 - - *75 + - *309 + - *310 + - *505 + - *72 - *17 - *19 responses: @@ -79606,13 +80273,13 @@ paths: application/json: schema: type: array - items: *506 + items: *501 examples: - default: *511 + default: *506 headers: - Link: *57 + Link: *52 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79641,9 +80308,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -79665,16 +80332,16 @@ paths: description: Response content: application/json: - schema: *506 + schema: *501 examples: - default: *507 + default: *502 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *320 + '410': *315 '422': *15 '404': *6 x-github: @@ -79702,9 +80369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -79714,14 +80381,14 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: *512 + default: *507 headers: - Link: *57 - '301': *323 + Link: *52 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79749,9 +80416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -79773,17 +80440,17 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *323 + '301': *318 '403': *27 - '410': *320 + '410': *315 '422': *15 '404': *6 x-github: @@ -79814,9 +80481,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -79828,15 +80495,15 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 - '301': *323 + default: *504 + '301': *318 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *320 + '410': *315 x-github: triggersNotification: true githubCloudOnly: false @@ -79862,9 +80529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -79874,14 +80541,14 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: *512 + default: *507 headers: - Link: *57 - '301': *323 + Link: *52 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79898,9 +80565,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -79914,7 +80581,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &514 + - &509 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -79963,7 +80630,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &515 + - &510 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -80091,7 +80758,7 @@ paths: - performed_via_github_app - assignee - assigner - - &516 + - &511 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -80137,7 +80804,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &517 + - &512 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -80183,7 +80850,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &518 + - &513 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -80232,7 +80899,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &519 + - &514 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -80261,7 +80928,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *161 + requested_team: *169 requested_reviewer: *4 required: - review_requester @@ -80274,7 +80941,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &520 + - &515 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -80303,7 +80970,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *161 + requested_team: *169 requested_reviewer: *4 required: - review_requester @@ -80316,7 +80983,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &521 + - &516 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -80372,7 +81039,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &522 + - &517 title: Locked Issue Event description: Locked Issue Event type: object @@ -80417,7 +81084,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &523 + - &518 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -80478,7 +81145,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &524 + - &519 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -80539,7 +81206,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &525 + - &520 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -80600,7 +81267,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &526 + - &521 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -80692,8 +81359,8 @@ paths: name: label color: red headers: - Link: *57 - '410': *320 + Link: *52 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80710,9 +81377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -80722,9 +81389,9 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: - default: &513 + default: &508 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80741,10 +81408,10 @@ paths: color: a2eeef default: false headers: - Link: *57 - '301': *323 + Link: *52 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80761,9 +81428,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: false content: @@ -80822,12 +81489,12 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: - default: *513 - '301': *323 + default: *508 + '301': *318 '404': *6 - '410': *320 + '410': *315 '422': *15 x-github: githubCloudOnly: false @@ -80844,9 +81511,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: false content: @@ -80906,12 +81573,12 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: - default: *513 - '301': *323 + default: *508 + '301': *318 '404': *6 - '410': *320 + '410': *315 '422': *15 x-github: githubCloudOnly: false @@ -80928,15 +81595,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 responses: '204': description: Response - '301': *323 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80955,9 +81622,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - name: name in: path required: true @@ -80970,7 +81637,7 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: default: value: @@ -80981,9 +81648,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *323 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81003,9 +81670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: false content: @@ -81034,7 +81701,7 @@ paths: '204': description: Response '403': *27 - '410': *320 + '410': *315 '404': *6 '422': *15 x-github: @@ -81052,9 +81719,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 responses: '204': description: Response @@ -81084,20 +81751,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 responses: '200': description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 - '301': *323 + default: *504 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81114,9 +81781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - 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. @@ -81142,13 +81809,13 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81166,9 +81833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -81200,16 +81867,16 @@ paths: description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -81231,10 +81898,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *314 - - *315 - - *510 + - *309 - *310 + - *505 + - *305 responses: '204': description: Response @@ -81263,9 +81930,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -81287,9 +81954,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -81322,9 +81989,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -81334,13 +82001,13 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: *512 + default: *507 headers: - Link: *57 + Link: *52 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81368,9 +82035,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -81397,16 +82064,16 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *320 + '410': *315 '422': *15 '404': *6 x-github: @@ -81426,9 +82093,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -81459,13 +82126,13 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 '403': *27 '404': *6 '422': *7 - '503': *73 + '503': *99 x-github: triggersNotification: true githubCloudOnly: false @@ -81483,9 +82150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -81500,6 +82167,11 @@ paths: description: Timeline Event type: object anyOf: + - *509 + - *510 + - *511 + - *512 + - *513 - *514 - *515 - *516 @@ -81508,11 +82180,6 @@ paths: - *519 - *520 - *521 - - *522 - - *523 - - *524 - - *525 - - *526 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -81560,12 +82227,12 @@ paths: issue_url: type: string format: uri - author_association: *69 + author_association: *67 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *70 + reactions: *68 required: - event - actor @@ -81596,7 +82263,7 @@ paths: properties: type: type: string - issue: *68 + issue: *66 required: - event - created_at @@ -81818,7 +82485,7 @@ paths: type: string body_text: type: string - author_association: *69 + author_association: *67 required: - event - id @@ -81841,7 +82508,7 @@ paths: type: string comments: type: array - items: &545 + items: &542 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -81946,7 +82613,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *69 + author_association: *67 _links: type: object properties: @@ -82041,7 +82708,7 @@ paths: enum: - line - file - reactions: *70 + reactions: *68 body_html: type: string examples: @@ -82079,7 +82746,7 @@ paths: type: string comments: type: array - items: *442 + items: *437 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -82352,9 +83019,9 @@ paths: type: User site_admin: true headers: - Link: *57 + Link: *52 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82371,8 +83038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -82382,7 +83049,7 @@ paths: application/json: schema: type: array - items: &527 + items: &522 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -82434,7 +83101,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82450,8 +83117,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -82487,9 +83154,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *522 examples: - default: &528 + default: &523 value: id: 1 key: ssh-rsa AAA... @@ -82523,9 +83190,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *314 - - *315 - - &529 + - *309 + - *310 + - &524 name: key_id description: The unique identifier of the key. in: path @@ -82537,9 +83204,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *522 examples: - default: *528 + default: *523 '404': *6 x-github: githubCloudOnly: false @@ -82557,9 +83224,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *314 - - *315 - - *529 + - *309 + - *310 + - *524 responses: '204': description: Response @@ -82579,8 +83246,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -82590,11 +83257,11 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: - default: *513 + default: *508 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -82613,8 +83280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -82650,9 +83317,9 @@ paths: description: Response content: application/json: - schema: *67 + schema: *65 examples: - default: &530 + default: &525 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82684,8 +83351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *314 - - *315 + - *309 + - *310 - name: name in: path required: true @@ -82696,9 +83363,9 @@ paths: description: Response content: application/json: - schema: *67 + schema: *65 examples: - default: *530 + default: *525 '404': *6 x-github: githubCloudOnly: false @@ -82715,8 +83382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *314 - - *315 + - *309 + - *310 - name: name in: path required: true @@ -82755,7 +83422,7 @@ paths: description: Response content: application/json: - schema: *67 + schema: *65 examples: default: value: @@ -82781,8 +83448,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *314 - - *315 + - *309 + - *310 - name: name in: path required: true @@ -82808,8 +83475,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -82848,9 +83515,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *314 - - *315 - - *420 + - *309 + - *310 + - *415 responses: '200': description: Response @@ -82916,7 +83583,7 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 required: - _links - git_url @@ -82997,8 +83664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -83063,8 +83730,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -83098,9 +83765,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *443 + schema: *438 examples: - default: *531 + default: *526 '204': description: Response when already merged '404': @@ -83125,8 +83792,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *314 - - *315 + - *309 + - *310 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -83167,7 +83834,7 @@ paths: application/json: schema: type: array - items: *238 + items: *244 examples: default: value: @@ -83206,7 +83873,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -83223,8 +83890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -83264,9 +83931,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *244 examples: - default: &532 + default: &527 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -83325,9 +83992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *314 - - *315 - - &533 + - *309 + - *310 + - &528 name: milestone_number description: The number that identifies the milestone. in: path @@ -83339,9 +84006,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *244 examples: - default: *532 + default: *527 '404': *6 x-github: githubCloudOnly: false @@ -83358,9 +84025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *314 - - *315 - - *533 + - *309 + - *310 + - *528 requestBody: required: false content: @@ -83398,9 +84065,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *244 examples: - default: *532 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83416,9 +84083,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *314 - - *315 - - *533 + - *309 + - *310 + - *528 responses: '204': description: Response @@ -83439,9 +84106,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *314 - - *315 - - *533 + - *309 + - *310 + - *528 - *17 - *19 responses: @@ -83451,11 +84118,11 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: - default: *513 + default: *508 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83472,12 +84139,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *314 - - *315 - - *534 - - *535 - - *75 - - *536 + - *309 + - *310 + - *529 + - *530 + - *72 + - *531 - *17 - *19 responses: @@ -83487,11 +84154,11 @@ paths: application/json: schema: type: array - items: *95 + items: *92 examples: - default: *537 + default: *532 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -83513,8 +84180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -83572,14 +84239,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &538 + schema: &533 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -83723,7 +84390,7 @@ paths: - custom_404 - public examples: - default: &539 + default: &534 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -83764,8 +84431,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -83820,9 +84487,9 @@ paths: description: Response content: application/json: - schema: *538 + schema: *533 examples: - default: *539 + default: *534 '422': *15 '409': *45 x-github: @@ -83845,8 +84512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -83946,8 +84613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -83973,8 +84640,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -83984,7 +84651,7 @@ paths: application/json: schema: type: array - items: &540 + items: &535 title: Page Build description: Page Build type: object @@ -84057,7 +84724,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84076,8 +84743,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *314 - - *315 + - *309 + - *310 responses: '201': description: Response @@ -84124,16 +84791,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *540 + schema: *535 examples: - default: &541 + default: &536 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -84181,8 +84848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *314 - - *315 + - *309 + - *310 - name: build_id in: path required: true @@ -84193,9 +84860,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *535 examples: - default: *541 + default: *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84215,8 +84882,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -84324,9 +84991,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *314 - - *315 - - &542 + - *309 + - *310 + - &537 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -84384,11 +85051,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *314 - - *315 - - *542 + - *309 + - *310 + - *537 responses: - '204': *156 + '204': *165 '404': *6 x-github: githubCloudOnly: false @@ -84413,8 +85080,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -84682,7 +85349,7 @@ paths: description: Empty response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -84709,8 +85376,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Private vulnerability reporting status @@ -84747,10 +85414,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: - '204': *156 + '204': *165 '422': *14 x-github: githubCloudOnly: false @@ -84769,10 +85436,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: - '204': *156 + '204': *165 '422': *14 x-github: githubCloudOnly: false @@ -84793,8 +85460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects parameters: - - *314 - - *315 + - *309 + - *310 - name: state description: Indicates the state of the projects to return. in: query @@ -84815,7 +85482,7 @@ paths: application/json: schema: type: array - items: *232 + items: *238 examples: default: value: @@ -84851,11 +85518,11 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *57 + Link: *52 '401': *23 '403': *27 '404': *6 - '410': *320 + '410': *315 '422': *7 x-github: githubCloudOnly: false @@ -84878,8 +85545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -84905,13 +85572,13 @@ paths: description: Response content: application/json: - schema: *232 + schema: *238 examples: - default: *319 + default: *314 '401': *23 '403': *27 '404': *6 - '410': *320 + '410': *315 '422': *7 x-github: githubCloudOnly: false @@ -84934,8 +85601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -84943,16 +85610,9 @@ paths: application/json: schema: type: array - items: *249 + items: *97 examples: - default: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *538 '403': *27 '404': *6 x-github: @@ -84974,8 +85634,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -84987,19 +85647,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *249 + items: *97 required: - properties examples: - default: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *539 responses: '204': description: No Content when custom property values are successfully created @@ -85037,8 +85689,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *314 - - *315 + - *309 + - *310 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -85098,11 +85750,11 @@ paths: application/json: schema: type: array - items: *447 + items: *442 examples: - default: *543 + default: *540 headers: - Link: *57 + Link: *52 '304': *35 '422': *15 x-github: @@ -85132,8 +85784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -85200,7 +85852,7 @@ paths: description: Response content: application/json: - schema: &547 + schema: &544 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -85329,7 +85981,7 @@ paths: milestone: anyOf: - type: 'null' - - *238 + - *244 active_lock_reason: type: - string @@ -85384,7 +86036,7 @@ paths: type: - array - 'null' - items: *214 + items: *220 head: type: object properties: @@ -85392,7 +86044,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *64 sha: type: string user: *4 @@ -85409,7 +86061,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *64 sha: type: string user: *4 @@ -85422,14 +86074,14 @@ paths: _links: type: object properties: - comments: *239 - commits: *239 - statuses: *239 - html: *239 - issue: *239 - review_comments: *239 - review_comment: *239 - self: *239 + comments: *245 + commits: *245 + statuses: *245 + html: *245 + issue: *245 + review_comments: *245 + review_comment: *245 + self: *245 required: - comments - commits @@ -85439,8 +86091,8 @@ paths: - review_comments - review_comment - self - author_association: *69 - auto_merge: *544 + author_association: *67 + auto_merge: *541 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -85542,7 +86194,7 @@ paths: - merged_by - review_comments examples: - default: &548 + default: &545 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -86069,8 +86721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - name: sort in: query required: false @@ -86089,7 +86741,7 @@ paths: enum: - asc - desc - - *75 + - *72 - *17 - *19 responses: @@ -86099,9 +86751,9 @@ paths: application/json: schema: type: array - items: *545 + items: *542 examples: - default: &550 + default: &547 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -86153,7 +86805,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86178,17 +86830,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '200': description: Response content: application/json: - schema: *545 + schema: *542 examples: - default: &546 + default: &543 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -86263,9 +86915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -86287,9 +86939,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *542 examples: - default: *546 + default: *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86305,9 +86957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '204': description: Response @@ -86328,9 +86980,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 - 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. @@ -86356,11 +87008,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -86379,9 +87031,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -86413,16 +87065,16 @@ paths: description: Reaction exists content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Reaction created content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -86444,10 +87096,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *314 - - *315 - - *84 + - *309 - *310 + - *81 + - *305 responses: '204': description: Response @@ -86490,9 +87142,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *314 - - *315 - - &549 + - *309 + - *310 + - &546 name: pull_number description: The number that identifies the pull request. in: path @@ -86505,9 +87157,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *547 + schema: *544 examples: - default: *548 + default: *545 '304': *35 '404': *6 '406': @@ -86515,8 +87167,8 @@ paths: content: application/json: schema: *3 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86542,9 +87194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: false content: @@ -86586,9 +87238,9 @@ paths: description: Response content: application/json: - schema: *547 + schema: *544 examples: - default: *548 + default: *545 '422': *15 '403': *27 x-github: @@ -86610,9 +87262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: true content: @@ -86673,21 +87325,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '401': *23 '403': *27 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86713,10 +87365,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *314 - - *315 - - *549 - - *92 + - *309 + - *310 + - *546 + - *89 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -86726,7 +87378,7 @@ paths: enum: - asc - desc - - *75 + - *72 - *17 - *19 responses: @@ -86736,11 +87388,11 @@ paths: application/json: schema: type: array - items: *545 + items: *542 examples: - default: *550 + default: *547 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86771,9 +87423,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: true content: @@ -86879,7 +87531,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *542 examples: example-for-a-multi-line-comment: value: @@ -86967,10 +87619,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *314 - - *315 - - *549 - - *84 + - *309 + - *310 + - *546 + - *81 requestBody: required: true content: @@ -86992,7 +87644,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *542 examples: default: value: @@ -87078,9 +87730,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 - *17 - *19 responses: @@ -87090,11 +87742,11 @@ paths: application/json: schema: type: array - items: *443 + items: *438 examples: - default: *551 + default: *548 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87122,9 +87774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 - *17 - *19 responses: @@ -87134,7 +87786,7 @@ paths: application/json: schema: type: array - items: *454 + items: *449 examples: default: value: @@ -87150,10 +87802,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *57 + Link: *52 '422': *15 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87172,9 +87824,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 responses: '204': description: Response if pull request has been merged @@ -87197,9 +87849,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: false content: @@ -87311,9 +87963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 responses: '200': description: Response @@ -87329,7 +87981,7 @@ paths: items: *4 teams: type: array - items: *161 + items: *169 required: - users - teams @@ -87370,7 +88022,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87388,9 +88040,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: false content: @@ -87427,7 +88079,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *442 examples: default: value: @@ -87963,9 +88615,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: true content: @@ -87999,7 +88651,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *442 examples: default: value: @@ -88504,9 +89156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 - *17 - *19 responses: @@ -88516,7 +89168,7 @@ paths: application/json: schema: type: array - items: &552 + items: &549 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -88590,7 +89242,7 @@ paths: type: string body_text: type: string - author_association: *69 + author_association: *67 required: - id - node_id @@ -88639,7 +89291,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88672,9 +89324,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: false content: @@ -88764,9 +89416,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *549 examples: - default: &554 + default: &551 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88829,10 +89481,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 - - &553 + - *309 + - *310 + - *546 + - &550 name: review_id description: The unique identifier of the review. in: path @@ -88844,9 +89496,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *549 examples: - default: &555 + default: &552 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88905,10 +89557,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 - - *553 + - *309 + - *310 + - *546 + - *550 requestBody: required: true content: @@ -88931,7 +89583,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *549 examples: default: value: @@ -88993,18 +89645,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 - - *553 + - *309 + - *310 + - *546 + - *550 responses: '200': description: Response content: application/json: - schema: *552 + schema: *549 examples: - default: *554 + default: *551 '422': *7 '404': *6 x-github: @@ -89031,10 +89683,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *314 - - *315 - - *549 - - *553 + - *309 + - *310 + - *546 + - *550 - *17 - *19 responses: @@ -89128,13 +89780,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *69 + author_association: *67 _links: type: object properties: - self: *239 - html: *239 - pull_request: *239 + self: *245 + html: *245 + pull_request: *245 required: - self - html @@ -89143,7 +89795,7 @@ paths: type: string body_html: type: string - reactions: *70 + reactions: *68 side: description: The side of the first line of the range for a multi-line comment. @@ -89263,7 +89915,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -89292,10 +89944,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 - - *553 + - *309 + - *310 + - *546 + - *550 requestBody: required: true content: @@ -89324,7 +89976,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *549 examples: default: value: @@ -89387,10 +90039,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 - - *553 + - *309 + - *310 + - *546 + - *550 requestBody: required: true content: @@ -89425,9 +90077,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *549 examples: - default: *555 + default: *552 '404': *6 '422': *7 '403': *27 @@ -89449,9 +90101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: false content: @@ -89515,8 +90167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *314 - - *315 + - *309 + - *310 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -89529,9 +90181,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *553 examples: - default: &557 + default: &554 value: type: file encoding: base64 @@ -89573,8 +90225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *314 - - *315 + - *309 + - *310 - name: dir description: The alternate path to look for a README file in: path @@ -89594,9 +90246,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *553 examples: - default: *557 + default: *554 '404': *6 '422': *15 x-github: @@ -89618,8 +90270,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -89629,7 +90281,7 @@ paths: application/json: schema: type: array - items: *558 + items: *555 examples: default: value: @@ -89703,7 +90355,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -89723,8 +90375,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -89800,9 +90452,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *555 examples: - default: &562 + default: &559 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -89907,9 +90559,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *314 - - *315 - - &560 + - *309 + - *310 + - &557 name: asset_id description: The unique identifier of the asset. in: path @@ -89921,9 +90573,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *556 examples: - default: &561 + default: &558 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 @@ -89958,7 +90610,7 @@ paths: type: User site_admin: false '404': *6 - '302': *456 + '302': *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89974,9 +90626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *314 - - *315 - - *560 + - *309 + - *310 + - *557 requestBody: required: false content: @@ -90005,9 +90657,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *556 examples: - default: *561 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90023,9 +90675,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *314 - - *315 - - *560 + - *309 + - *310 + - *557 responses: '204': description: Response @@ -90049,8 +90701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -90136,16 +90788,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *558 + schema: *555 examples: - default: *562 + default: *559 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90162,8 +90814,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *314 - - *315 + - *309 + - *310 - name: tag description: tag parameter in: path @@ -90176,9 +90828,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *555 examples: - default: *562 + default: *559 '404': *6 x-github: githubCloudOnly: false @@ -90200,9 +90852,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *314 - - *315 - - &563 + - *309 + - *310 + - &560 name: release_id description: The unique identifier of the release. in: path @@ -90216,9 +90868,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: *558 + schema: *555 examples: - default: *562 + default: *559 '401': description: Unauthorized x-github: @@ -90236,9 +90888,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 requestBody: required: false content: @@ -90302,9 +90954,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *555 examples: - default: *562 + default: *559 '404': description: Not Found if the discussion category name is invalid content: @@ -90325,9 +90977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 responses: '204': description: Response @@ -90347,9 +90999,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 - *17 - *19 responses: @@ -90359,7 +91011,7 @@ paths: application/json: schema: type: array - items: *559 + items: *556 examples: default: value: @@ -90396,7 +91048,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90440,9 +91092,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: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 - name: name in: query required: true @@ -90468,7 +91120,7 @@ paths: description: Response for successful upload content: application/json: - schema: *559 + schema: *556 examples: response-for-successful-upload: value: @@ -90523,9 +91175,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 - 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. @@ -90549,11 +91201,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -90572,9 +91224,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 requestBody: required: true content: @@ -90604,16 +91256,16 @@ paths: description: Reaction exists content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Reaction created content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -90635,10 +91287,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *314 - - *315 - - *563 + - *309 - *310 + - *560 + - *305 responses: '204': description: Response @@ -90662,9 +91314,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 - *17 - *19 responses: @@ -90680,8 +91332,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *256 - - &564 + - *261 + - &561 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -90700,69 +91352,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *257 - - *564 - - allOf: - - *258 - - *564 - - allOf: - - *259 - - *564 - - allOf: - - *565 - - *564 - - allOf: - - *260 - - *564 - - allOf: - - *261 - - *564 - allOf: - *262 - - *564 + - *561 - allOf: - *263 - - *564 + - *561 - allOf: - *264 - - *564 + - *561 + - allOf: + - *562 + - *561 - allOf: - *265 - - *564 + - *561 - allOf: - *266 - - *564 + - *561 - allOf: - *267 - - *564 + - *561 - allOf: - *268 - - *564 + - *561 - allOf: - *269 - - *564 + - *561 - allOf: - *270 - - *564 + - *561 - allOf: - *271 - - *564 + - *561 - allOf: - *272 - - *564 + - *561 - allOf: - *273 - - *564 + - *561 - allOf: - *274 - - *564 + - *561 - allOf: - *275 - - *564 + - *561 + - allOf: + - *276 + - *561 + - allOf: + - *277 + - *561 - allOf: - - *566 - - *564 + - *278 + - *561 + - allOf: + - *279 + - *561 + - allOf: + - *280 + - *561 + - allOf: + - *563 + - *561 examples: default: value: @@ -90801,8 +91453,8 @@ paths: category: repos subcategory: rules parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 - name: includes_parents @@ -90813,7 +91465,7 @@ paths: schema: type: boolean default: true - - *567 + - *564 responses: '200': description: Response @@ -90821,7 +91473,7 @@ paths: application/json: schema: type: array - items: *276 + items: *281 examples: default: value: @@ -90852,7 +91504,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *100 + '500': *98 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -90868,8 +91520,8 @@ paths: category: repos subcategory: rules parameters: - - *314 - - *315 + - *309 + - *310 requestBody: description: Request body required: true @@ -90889,16 +91541,16 @@ paths: - tag - push default: branch - enforcement: *253 + enforcement: *258 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *254 - conditions: *251 + items: *259 + conditions: *256 rules: type: array description: An array of rules within the ruleset. - items: *568 + items: *565 required: - name - enforcement @@ -90929,9 +91581,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: &578 + default: &575 value: id: 42 name: super cool ruleset @@ -90964,7 +91616,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *100 + '500': *98 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -90978,12 +91630,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *314 - - *315 + - *309 + - *310 + - *566 + - *567 + - *568 - *569 - - *570 - - *571 - - *572 - *17 - *19 responses: @@ -90991,11 +91643,11 @@ paths: description: Response content: application/json: - schema: *573 + schema: *570 examples: - default: *574 + default: *571 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91014,19 +91666,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *314 - - *315 - - *575 + - *309 + - *310 + - *572 responses: '200': description: Response content: application/json: - schema: *576 + schema: *573 examples: - default: *577 + default: *574 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91052,8 +91704,8 @@ paths: category: repos subcategory: rules parameters: - - *314 - - *315 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91073,11 +91725,11 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *578 + default: *575 '404': *6 - '500': *100 + '500': *98 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -91093,8 +91745,8 @@ paths: category: repos subcategory: rules parameters: - - *314 - - *315 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91119,16 +91771,16 @@ paths: - branch - tag - push - enforcement: *253 + enforcement: *258 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *254 - conditions: *251 + items: *259 + conditions: *256 rules: description: An array of rules within the ruleset. type: array - items: *568 + items: *565 examples: default: value: @@ -91156,11 +91808,11 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *578 + default: *575 '404': *6 - '500': *100 + '500': *98 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -91176,8 +91828,8 @@ paths: category: repos subcategory: rules parameters: - - *314 - - *315 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91188,7 +91840,7 @@ paths: '204': description: Response '404': *6 - '500': *100 + '500': *98 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -91200,8 +91852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 - name: ruleset_id @@ -91217,11 +91869,11 @@ paths: application/json: schema: type: array - items: *279 + items: *284 examples: - default: *579 + default: *576 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91238,8 +91890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *314 - - *315 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91257,7 +91909,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *577 examples: default: value: @@ -91290,7 +91942,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91312,21 +91964,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *314 - - *315 - - *280 - - *281 - - *282 - - *283 + - *309 + - *310 + - *578 + - *579 + - *580 + - *581 - *46 - *19 - *17 - - *581 - *582 - - *284 - - *285 - - *286 - - *287 + - *583 + - *584 + - *585 + - *586 + - *587 responses: '200': description: Response @@ -91334,24 +91986,24 @@ paths: application/json: schema: type: array - items: &586 + items: &591 type: object properties: - number: *52 - created_at: *53 + number: *151 + created_at: *152 updated_at: anyOf: - type: 'null' - - *54 - url: *55 - html_url: *56 + - *153 + url: *154 + html_url: *155 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *583 - resolution: *584 + state: *588 + resolution: *589 resolved_at: type: - string @@ -91445,7 +92097,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *585 + - *590 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -91568,7 +92220,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91590,16 +92242,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *314 - - *315 - - *414 - - *287 + - *309 + - *310 + - *409 + - *587 responses: '200': description: Response content: application/json: - schema: *586 + schema: *591 examples: default: value: @@ -91630,7 +92282,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91651,9 +92303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 requestBody: required: true content: @@ -91661,8 +92313,8 @@ paths: schema: type: object properties: - state: *583 - resolution: *584 + state: *588 + resolution: *589 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -91681,7 +92333,7 @@ paths: description: Response content: application/json: - schema: *586 + schema: *591 examples: default: value: @@ -91734,7 +92386,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -91756,9 +92408,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 - *19 - *17 responses: @@ -91769,7 +92421,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &739 + items: &743 type: object properties: type: @@ -91796,11 +92448,6 @@ paths: - commit details: oneOf: - - *587 - - *588 - - *589 - - *590 - - *591 - *592 - *593 - *594 @@ -91809,6 +92456,11 @@ paths: - *597 - *598 - *599 + - *600 + - *601 + - *602 + - *603 + - *604 examples: default: value: @@ -91868,11 +92520,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *57 + Link: *52 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91894,8 +92546,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -91903,14 +92555,14 @@ paths: schema: type: object properties: - reason: &601 + reason: &606 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *600 + placeholder_id: *605 required: - reason - placeholder_id @@ -91927,7 +92579,7 @@ paths: schema: type: object properties: - reason: *601 + reason: *606 expire_at: type: - string @@ -91951,7 +92603,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -91963,6 +92615,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 @@ -91971,13 +92626,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: - - *314 - - *315 + - *309 + - *310 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *73 + '503': *99 '200': description: Response content: @@ -91987,7 +92642,7 @@ paths: properties: incremental_scans: type: array - items: &602 + items: &607 description: Information on a single scan performed by secret scanning on the repository type: object @@ -92015,15 +92670,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *602 + items: *607 backfill_scans: type: array - items: *602 + items: *607 custom_pattern_backfill_scans: type: array items: allOf: - - *602 + - *607 - type: object properties: pattern_name: @@ -92093,8 +92748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *314 - - *315 + - *309 + - *310 - *46 - name: sort description: The property to sort the results by. @@ -92138,9 +92793,9 @@ paths: application/json: schema: type: array - items: *603 + items: *608 examples: - default: *604 + default: *609 '400': *14 '404': *6 x-github: @@ -92163,8 +92818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -92244,7 +92899,7 @@ paths: login: type: string description: The username of the user credited. - type: *292 + type: *287 required: - login - type @@ -92334,9 +92989,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *608 examples: - default: &606 + default: &611 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -92569,8 +93224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -92683,7 +93338,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *608 examples: default: value: @@ -92830,17 +93485,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *314 - - *315 - - *605 + - *309 + - *310 + - *610 responses: '200': description: Response content: application/json: - schema: *603 + schema: *608 examples: - default: *606 + default: *611 '403': *27 '404': *6 x-github: @@ -92864,9 +93519,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *314 - - *315 - - *605 + - *309 + - *310 + - *610 requestBody: required: true content: @@ -92946,7 +93601,7 @@ paths: login: type: string description: The username of the user credited. - type: *292 + type: *287 required: - login - type @@ -93037,17 +93692,17 @@ paths: description: Response content: application/json: - schema: *603 + schema: *608 examples: - default: *606 - add_credit: *606 + default: *611 + add_credit: *611 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *105 + schema: *104 examples: invalid_state_transition: value: @@ -93078,9 +93733,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: - - *314 - - *315 - - *605 + - *309 + - *310 + - *610 responses: '202': *37 '400': *14 @@ -93107,17 +93762,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *314 - - *315 - - *605 + - *309 + - *310 + - *610 responses: '202': description: Response content: application/json: - schema: *322 + schema: *317 examples: - default: *324 + default: *319 '400': *14 '422': *15 '403': *27 @@ -93143,8 +93798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -93218,7 +93873,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 '422': *15 x-github: githubCloudOnly: false @@ -93240,8 +93895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -93250,7 +93905,7 @@ paths: application/json: schema: type: array - items: &607 + items: &612 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -93263,7 +93918,7 @@ paths: - 1124 - -435 '202': *37 - '204': *156 + '204': *165 '422': description: Repository contains more than 10,000 commits x-github: @@ -93283,8 +93938,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -93335,7 +93990,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *156 + '204': *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93362,8 +94017,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -93435,7 +94090,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *156 + '204': *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93457,8 +94112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -93612,8 +94267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -93623,7 +94278,7 @@ paths: application/json: schema: type: array - items: *607 + items: *612 examples: default: value: @@ -93636,7 +94291,7 @@ paths: - - 0 - 2 - 21 - '204': *156 + '204': *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93656,8 +94311,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *314 - - *315 + - *309 + - *310 - name: sha in: path required: true @@ -93713,7 +94368,7 @@ paths: description: Response content: application/json: - schema: *608 + schema: *613 examples: default: value: @@ -93767,8 +94422,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -93780,9 +94435,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93800,14 +94455,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &609 + schema: &614 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -93880,8 +94535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -93907,7 +94562,7 @@ paths: description: Response content: application/json: - schema: *609 + schema: *614 examples: default: value: @@ -93934,8 +94589,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -93955,8 +94610,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -94015,7 +94670,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94038,8 +94693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -94047,7 +94702,7 @@ paths: application/json: schema: type: array - items: &610 + items: &615 title: Tag protection description: Tag protection type: object @@ -94104,8 +94759,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -94128,7 +94783,7 @@ paths: description: Response content: application/json: - schema: *610 + schema: *615 examples: default: value: @@ -94159,8 +94814,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: - - *314 - - *315 + - *309 + - *310 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -94197,8 +94852,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *314 - - *315 + - *309 + - *310 - name: ref in: path required: true @@ -94234,8 +94889,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -94245,11 +94900,11 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -94267,8 +94922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *314 - - *315 + - *309 + - *310 - *19 - *17 responses: @@ -94276,7 +94931,7 @@ paths: description: Response content: application/json: - schema: &611 + schema: &616 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -94288,7 +94943,7 @@ paths: required: - names examples: - default: &612 + default: &617 value: names: - octocat @@ -94311,8 +94966,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -94343,9 +94998,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *616 examples: - default: *612 + default: *617 '404': *6 '422': *7 x-github: @@ -94366,9 +95021,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *314 - - *315 - - &613 + - *309 + - *310 + - &618 name: per description: The time frame to display results for. in: query @@ -94399,7 +95054,7 @@ paths: - 128 clones: type: array - items: &614 + items: &619 title: Traffic type: object properties: @@ -94486,8 +95141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -94581,8 +95236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -94645,9 +95300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *314 - - *315 - - *613 + - *309 + - *310 + - *618 responses: '200': description: Response @@ -94668,7 +95323,7 @@ paths: - 3782 views: type: array - items: *614 + items: *619 required: - uniques - count @@ -94745,8 +95400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -94782,7 +95437,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *135 examples: default: value: @@ -95020,8 +95675,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -95044,8 +95699,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -95067,8 +95722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -95094,8 +95749,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *314 - - *315 + - *309 + - *310 - name: ref in: path required: true @@ -95187,9 +95842,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *317 examples: - default: *324 + default: *319 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -95230,7 +95885,7 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: default: value: @@ -95419,7 +96074,7 @@ paths: html_url: type: string format: uri - repository: *131 + repository: *135 score: type: number file_size: @@ -95438,7 +96093,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &615 + text_matches: &620 title: Search Result Text Matches type: array items: @@ -95553,7 +96208,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *73 + '503': *99 '422': *15 '403': *27 x-github: @@ -95601,7 +96256,7 @@ paths: enum: - author-date - committer-date - - &616 + - &621 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 @@ -95670,7 +96325,7 @@ paths: committer: anyOf: - type: 'null' - - *382 + - *377 comment_count: type: integer message: @@ -95689,7 +96344,7 @@ paths: url: type: string format: uri - verification: *492 + verification: *487 required: - author - committer @@ -95704,7 +96359,7 @@ paths: committer: anyOf: - type: 'null' - - *382 + - *377 parents: type: array items: @@ -95716,12 +96371,12 @@ paths: type: string sha: type: string - repository: *131 + repository: *135 score: type: number node_id: type: string - text_matches: *615 + text_matches: *620 required: - sha - node_id @@ -95913,7 +96568,7 @@ paths: - interactions - created - updated - - *616 + - *621 - *17 - *19 - name: advanced_search @@ -96010,11 +96665,11 @@ paths: type: - string - 'null' - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: type: string state_reason: @@ -96028,7 +96683,7 @@ paths: milestone: anyOf: - type: 'null' - - *238 + - *244 comments: type: integer created_at: @@ -96042,7 +96697,7 @@ paths: - string - 'null' format: date-time - text_matches: *615 + text_matches: *620 pull_request: type: object properties: @@ -96080,10 +96735,10 @@ paths: type: string score: type: number - author_association: *69 + author_association: *67 draft: type: boolean - repository: *66 + repository: *64 body_html: type: string body_text: @@ -96091,12 +96746,12 @@ paths: timeline_url: type: string format: uri - type: *199 + type: *205 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *70 + reactions: *68 required: - assignee - closed_at @@ -96212,7 +96867,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *73 + '503': *99 '422': *15 '304': *35 '403': *27 @@ -96265,7 +96920,7 @@ paths: enum: - created - updated - - *616 + - *621 - *17 - *19 responses: @@ -96310,7 +96965,7 @@ paths: - 'null' score: type: number - text_matches: *615 + text_matches: *620 required: - id - node_id @@ -96395,7 +97050,7 @@ paths: - forks - help-wanted-issues - updated - - *616 + - *621 - *17 - *19 responses: @@ -96614,7 +97269,7 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 permissions: type: object properties: @@ -96632,7 +97287,7 @@ paths: - admin - pull - push - text_matches: *615 + text_matches: *620 temp_clone_token: type: string allow_merge_commit: @@ -96835,7 +97490,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *73 + '503': *99 '422': *15 '304': *35 x-github: @@ -96940,7 +97595,7 @@ paths: - string - 'null' format: uri - text_matches: *615 + text_matches: *620 related: type: - array @@ -97133,7 +97788,7 @@ paths: - followers - repositories - joined - - *616 + - *621 - *17 - *19 responses: @@ -97243,7 +97898,7 @@ paths: type: - boolean - 'null' - text_matches: *615 + text_matches: *620 blog: type: - string @@ -97305,7 +97960,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *73 + '503': *99 '422': *15 x-github: githubCloudOnly: false @@ -97325,7 +97980,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &620 + - &625 name: team_id description: The unique identifier of the team. in: path @@ -97337,9 +97992,9 @@ paths: description: Response content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '404': *6 x-github: githubCloudOnly: false @@ -97366,7 +98021,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *620 + - *625 requestBody: required: true content: @@ -97430,16 +98085,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '201': description: Response content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '404': *6 '422': *15 '403': *27 @@ -97467,7 +98122,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *620 + - *625 responses: '204': description: Response @@ -97498,7 +98153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *620 + - *625 - *46 - *17 - *19 @@ -97509,11 +98164,11 @@ paths: application/json: schema: type: array - items: *301 + items: *296 examples: - default: *621 + default: *626 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97540,7 +98195,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *620 + - *625 requestBody: required: true content: @@ -97574,9 +98229,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: *302 + default: *297 x-github: triggersNotification: true githubCloudOnly: false @@ -97603,16 +98258,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *620 - - *303 + - *625 + - *298 responses: '200': description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: *302 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97637,8 +98292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *620 - - *303 + - *625 + - *298 requestBody: required: false content: @@ -97661,9 +98316,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: *622 + default: *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97688,8 +98343,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *620 - - *303 + - *625 + - *298 responses: '204': description: Response @@ -97718,8 +98373,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *620 - - *303 + - *625 + - *298 - *46 - *17 - *19 @@ -97730,11 +98385,11 @@ paths: application/json: schema: type: array - items: *304 + items: *299 examples: - default: *623 + default: *628 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97761,8 +98416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *620 - - *303 + - *625 + - *298 requestBody: required: true content: @@ -97784,9 +98439,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: *305 + default: *300 x-github: triggersNotification: true githubCloudOnly: false @@ -97813,17 +98468,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *620 - - *303 - - *306 + - *625 + - *298 + - *301 responses: '200': description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: *305 + default: *300 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97848,9 +98503,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *620 - - *303 - - *306 + - *625 + - *298 + - *301 requestBody: required: true content: @@ -97872,9 +98527,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: *624 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97899,9 +98554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *620 - - *303 - - *306 + - *625 + - *298 + - *301 responses: '204': description: Response @@ -97930,9 +98585,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *620 - - *303 - - *306 + - *625 + - *298 + - *301 - 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. @@ -97958,11 +98613,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97989,9 +98644,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *620 - - *303 - - *306 + - *625 + - *298 + - *301 requestBody: required: true content: @@ -98023,9 +98678,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98051,8 +98706,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *620 - - *303 + - *625 + - *298 - 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. @@ -98078,11 +98733,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98109,8 +98764,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *620 - - *303 + - *625 + - *298 requestBody: required: true content: @@ -98142,9 +98797,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98168,7 +98823,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *620 + - *625 - *17 - *19 responses: @@ -98178,11 +98833,11 @@ paths: application/json: schema: type: array - items: *196 + items: *202 examples: - default: *197 + default: *203 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98206,7 +98861,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *620 + - *625 - name: role description: Filters members returned by their role in the team. in: query @@ -98229,9 +98884,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -98257,8 +98912,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *620 - - *62 + - *625 + - *57 responses: '204': description: if user is a member @@ -98294,8 +98949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *620 - - *62 + - *625 + - *57 responses: '204': description: Response @@ -98334,8 +98989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *620 - - *62 + - *625 + - *57 responses: '204': description: Response @@ -98371,16 +99026,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *620 - - *62 + - *625 + - *57 responses: '200': description: Response content: application/json: - schema: *311 + schema: *306 examples: - response-if-user-is-a-team-maintainer: *625 + response-if-user-is-a-team-maintainer: *630 '404': *6 x-github: githubCloudOnly: false @@ -98413,8 +99068,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *620 - - *62 + - *625 + - *57 requestBody: required: false content: @@ -98439,9 +99094,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *306 examples: - response-if-users-membership-with-team-is-now-pending: *626 + response-if-users-membership-with-team-is-now-pending: *631 '403': description: Forbidden if team synchronization is set up '422': @@ -98475,8 +99130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *620 - - *62 + - *625 + - *57 responses: '204': description: Response @@ -98504,7 +99159,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *620 + - *625 - *17 - *19 responses: @@ -98514,11 +99169,11 @@ paths: application/json: schema: type: array - items: *312 + items: *307 examples: - default: *627 + default: *632 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -98542,16 +99197,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *620 - - *313 + - *625 + - *308 responses: '200': description: Response content: application/json: - schema: *312 + schema: *307 examples: - default: *628 + default: *633 '404': description: Not Found if project is not managed by this team x-github: @@ -98575,8 +99230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *620 - - *313 + - *625 + - *308 requestBody: required: false content: @@ -98643,8 +99298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *620 - - *313 + - *625 + - *308 responses: '204': description: Response @@ -98671,7 +99326,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *620 + - *625 - *17 - *19 responses: @@ -98681,11 +99336,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -98713,15 +99368,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *620 - - *314 - - *315 + - *625 + - *309 + - *310 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *629 + schema: *634 examples: alternative-response-with-extra-repository-information: value: @@ -98872,9 +99527,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *620 - - *314 - - *315 + - *625 + - *309 + - *310 requestBody: required: false content: @@ -98924,9 +99579,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *620 - - *314 - - *315 + - *625 + - *309 + - *310 responses: '204': description: Response @@ -98951,7 +99606,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *620 + - *625 - *17 - *19 responses: @@ -98961,11 +99616,11 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - response-if-child-teams-exist: *630 + response-if-child-teams-exist: *635 headers: - Link: *57 + Link: *52 '404': *6 '403': *27 '422': *15 @@ -98996,7 +99651,7 @@ paths: application/json: schema: oneOf: - - &632 + - &637 title: Private User description: Private User type: object @@ -99246,7 +99901,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *631 + - *636 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -99406,7 +100061,7 @@ paths: description: Response content: application/json: - schema: *632 + schema: *637 examples: default: value: @@ -99485,7 +100140,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 '304': *35 '404': *6 '403': *27 @@ -99508,7 +100163,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: - - *62 + - *57 responses: '204': description: If the user is blocked @@ -99536,7 +100191,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *62 + - *57 responses: '204': description: Response @@ -99560,7 +100215,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *62 + - *57 responses: '204': description: Response @@ -99609,11 +100264,11 @@ paths: type: integer codespaces: type: array - items: *204 + items: *210 examples: - default: *205 + default: *211 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -99750,21 +100405,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '401': *23 '403': *27 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99804,7 +100459,7 @@ paths: type: integer secrets: type: array - items: &633 + items: &638 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -99846,9 +100501,9 @@ paths: - visibility - selected_repositories_url examples: - default: *436 + default: *431 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99918,13 +100573,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *139 + - *143 responses: '200': description: Response content: application/json: - schema: *633 + schema: *638 examples: default: value: @@ -99954,7 +100609,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *139 + - *143 requestBody: required: true content: @@ -99999,7 +100654,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -100027,7 +100682,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *139 + - *143 responses: '204': description: Response @@ -100052,7 +100707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *139 + - *143 responses: '200': description: Response @@ -100068,13 +100723,13 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: *634 + default: *639 '401': *23 '403': *27 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100095,7 +100750,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *139 + - *143 requestBody: required: true content: @@ -100127,7 +100782,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100149,7 +100804,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *139 + - *143 - name: repository_id in: path required: true @@ -100161,7 +100816,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100182,7 +100837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *139 + - *143 - name: repository_id in: path required: true @@ -100194,7 +100849,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100214,17 +100869,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -100248,7 +100903,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 requestBody: required: false content: @@ -100278,9 +100933,9 @@ paths: description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '401': *23 '403': *27 '404': *6 @@ -100302,11 +100957,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 responses: '202': *37 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -100331,13 +100986,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 responses: '202': description: Response content: application/json: - schema: &635 + schema: &640 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100390,7 +101045,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &636 + default: &641 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100398,7 +101053,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -100422,7 +101077,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *206 + - *212 - name: export_id in: path required: true @@ -100435,9 +101090,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *640 examples: - default: *636 + default: *641 '404': *6 x-github: githubCloudOnly: false @@ -100458,7 +101113,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *206 + - *212 responses: '200': description: Response @@ -100474,11 +101129,11 @@ paths: type: integer machines: type: array - items: *435 + items: *430 examples: - default: *637 + default: *642 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -100505,7 +101160,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *206 + - *212 requestBody: required: true content: @@ -100561,11 +101216,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *322 + repository: *317 machine: anyOf: - type: 'null' - - *435 + - *430 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -101362,17 +102017,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '304': *35 - '500': *100 + '500': *98 '400': *14 '401': *23 '402': @@ -101402,16 +102057,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *434 - '500': *100 + default: *429 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -101440,9 +102095,9 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: &649 + default: &653 value: - id: 197 name: hello_docker @@ -101543,7 +102198,7 @@ paths: application/json: schema: type: array - items: &638 + items: &643 title: Email description: Email type: object @@ -101613,16 +102268,16 @@ paths: application/json: schema: type: array - items: *638 + items: *643 examples: - default: &651 + default: &655 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -101692,7 +102347,7 @@ paths: application/json: schema: type: array - items: *638 + items: *643 examples: default: value: @@ -101804,9 +102459,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -101837,9 +102492,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -101859,7 +102514,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: - - *62 + - *57 responses: '204': description: if the person is followed by the authenticated user @@ -101889,7 +102544,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *62 + - *57 responses: '204': description: Response @@ -101914,7 +102569,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *62 + - *57 responses: '204': description: Response @@ -101950,7 +102605,7 @@ paths: application/json: schema: type: array - items: &639 + items: &644 title: GPG Key description: A unique encryption key type: object @@ -102095,7 +102750,7 @@ paths: - subkeys - revoked examples: - default: &665 + default: &669 value: - id: 3 name: Octocat's GPG Key @@ -102127,7 +102782,7 @@ paths: revoked: false raw_key: string headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -102180,9 +102835,9 @@ paths: description: Response content: application/json: - schema: *639 + schema: *644 examples: - default: &640 + default: &645 value: id: 3 name: Octocat's GPG Key @@ -102239,7 +102894,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &641 + - &646 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102251,9 +102906,9 @@ paths: description: Response content: application/json: - schema: *639 + schema: *644 examples: - default: *640 + default: *645 '404': *6 '304': *35 '403': *27 @@ -102276,7 +102931,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *641 + - *646 responses: '204': description: Response @@ -102419,7 +103074,7 @@ paths: suspended_at: suspended_by: headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -102465,11 +103120,11 @@ paths: type: string repositories: type: array - items: *66 + items: *64 examples: - default: *123 + default: *127 headers: - Link: *57 + Link: *52 '404': *6 '403': *27 '304': *35 @@ -102492,7 +103147,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *120 + - *124 responses: '204': description: Response @@ -102518,7 +103173,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *120 + - *124 responses: '204': description: Response @@ -102552,12 +103207,12 @@ paths: application/json: schema: anyOf: - - *194 + - *200 - type: object properties: {} additionalProperties: false examples: - default: *195 + default: *201 '204': description: Response when there are no restrictions x-github: @@ -102581,7 +103236,7 @@ paths: required: true content: application/json: - schema: *503 + schema: *498 examples: default: value: @@ -102592,7 +103247,7 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: default: value: @@ -102673,7 +103328,7 @@ paths: - closed - all default: open - - *202 + - *208 - name: sort description: What to sort results by. in: query @@ -102686,7 +103341,7 @@ paths: - comments default: created - *46 - - *75 + - *72 - *17 - *19 responses: @@ -102696,11 +103351,11 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: *203 + default: *209 headers: - Link: *57 + Link: *52 '404': *6 '304': *35 x-github: @@ -102731,7 +103386,7 @@ paths: application/json: schema: type: array - items: &642 + items: &647 title: Key description: Key type: object @@ -102783,7 +103438,7 @@ paths: verified: false read_only: false headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -102834,9 +103489,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *647 examples: - default: &643 + default: &648 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -102869,15 +103524,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *529 + - *524 responses: '200': description: Response content: application/json: - schema: *642 + schema: *647 examples: - default: *643 + default: *648 '404': *6 '304': *35 '403': *27 @@ -102900,7 +103555,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *529 + - *524 responses: '204': description: Response @@ -102933,7 +103588,7 @@ paths: application/json: schema: type: array - items: &644 + items: &649 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -103001,7 +103656,7 @@ paths: - id - type - login - plan: *86 + plan: *83 required: - billing_cycle - next_billing_date @@ -103012,7 +103667,7 @@ paths: - account - plan examples: - default: &645 + default: &650 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -103045,7 +103700,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *57 + Link: *52 '304': *35 '401': *23 '404': *6 @@ -103074,11 +103729,11 @@ paths: application/json: schema: type: array - items: *644 + items: *649 examples: - default: *645 + default: *650 headers: - Link: *57 + Link: *52 '304': *35 '401': *23 x-github: @@ -103116,7 +103771,7 @@ paths: application/json: schema: type: array - items: *208 + items: *214 examples: default: value: @@ -103193,7 +103848,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -103218,13 +103873,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: *208 + schema: *214 examples: default: value: @@ -103282,7 +103937,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *99 + - *61 requestBody: required: true content: @@ -103307,7 +103962,7 @@ paths: description: Response content: application/json: - schema: *208 + schema: *214 examples: default: value: @@ -103375,7 +104030,7 @@ paths: application/json: schema: type: array - items: *210 + items: *216 examples: default: value: @@ -103528,7 +104183,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -103637,7 +104292,7 @@ paths: description: Response content: application/json: - schema: *210 + schema: *216 examples: default: value: @@ -103817,7 +104472,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *211 + - *217 - name: exclude in: query required: false @@ -103830,7 +104485,7 @@ paths: description: Response content: application/json: - schema: *210 + schema: *216 examples: default: value: @@ -104024,7 +104679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *211 + - *217 responses: '302': description: Response @@ -104050,7 +104705,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *211 + - *217 responses: '204': description: Response @@ -104079,8 +104734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *211 - - *646 + - *217 + - *651 responses: '204': description: Response @@ -104104,7 +104759,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *211 + - *217 - *17 - *19 responses: @@ -104114,11 +104769,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -104151,11 +104806,11 @@ paths: application/json: schema: type: array - items: *160 + items: *59 examples: - default: *647 + default: *96 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -104195,7 +104850,7 @@ paths: - docker - nuget - container - - *648 + - *652 - *19 - *17 responses: @@ -104205,10 +104860,10 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *649 - '400': *650 + default: *653 + '400': *654 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104228,16 +104883,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *218 - - *219 + - *224 + - *225 responses: '200': description: Response content: application/json: - schema: *216 + schema: *222 examples: - default: &666 + default: &670 value: id: 40201 name: octo-name @@ -104350,8 +105005,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *218 - - *219 + - *224 + - *225 responses: '204': description: Response @@ -104381,8 +105036,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *218 - - *219 + - *224 + - *225 - name: token description: package token schema: @@ -104414,8 +105069,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: - - *218 - - *219 + - *224 + - *225 - *19 - *17 - name: state @@ -104435,7 +105090,7 @@ paths: application/json: schema: type: array - items: *220 + items: *226 examples: default: value: @@ -104484,15 +105139,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *218 - - *219 - - *221 + - *224 + - *225 + - *227 responses: '200': description: Response content: application/json: - schema: *220 + schema: *226 examples: default: value: @@ -104528,9 +105183,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *218 - - *219 - - *221 + - *224 + - *225 + - *227 responses: '204': description: Response @@ -104560,9 +105215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *218 - - *219 - - *221 + - *224 + - *225 + - *227 responses: '204': description: Response @@ -104620,7 +105275,7 @@ paths: description: Response content: application/json: - schema: *232 + schema: *238 examples: default: value: @@ -104692,11 +105347,11 @@ paths: application/json: schema: type: array - items: *638 + items: *643 examples: - default: *651 + default: *655 headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -104805,9 +105460,9 @@ paths: application/json: schema: type: array - items: *66 + items: *64 examples: - default: &658 + default: &662 summary: Default response value: - id: 1296269 @@ -104928,7 +105583,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *57 + Link: *52 '422': *15 '304': *35 '403': *27 @@ -105125,9 +105780,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *317 examples: - default: *324 + default: *319 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105165,11 +105820,11 @@ paths: application/json: schema: type: array - items: *505 + items: *500 examples: - default: *652 + default: *656 headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -105190,7 +105845,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *198 + - *204 responses: '204': description: Response @@ -105213,7 +105868,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *198 + - *204 responses: '204': description: Response @@ -105246,7 +105901,7 @@ paths: application/json: schema: type: array - items: &653 + items: &657 title: Social account description: Social media account type: object @@ -105263,12 +105918,12 @@ paths: - provider - url examples: - default: &654 + default: &658 value: - provider: twitter url: https://twitter.com/github headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -105326,9 +105981,9 @@ paths: application/json: schema: type: array - items: *653 + items: *657 examples: - default: *654 + default: *658 '422': *15 '304': *35 '404': *6 @@ -105416,7 +106071,7 @@ paths: application/json: schema: type: array - items: &655 + items: &659 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105436,7 +106091,7 @@ paths: - title - created_at examples: - default: &680 + default: &684 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105449,7 +106104,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -105503,9 +106158,9 @@ paths: description: Response content: application/json: - schema: *655 + schema: *659 examples: - default: &656 + default: &660 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105536,7 +106191,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: - - &657 + - &661 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105548,9 +106203,9 @@ paths: description: Response content: application/json: - schema: *655 + schema: *659 examples: - default: *656 + default: *660 '404': *6 '304': *35 '403': *27 @@ -105573,7 +106228,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: - - *657 + - *661 responses: '204': description: Response @@ -105602,7 +106257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &681 + - &685 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 @@ -105625,13 +106280,13 @@ paths: application/json: schema: type: array - items: *66 + items: *64 examples: - default-response: *658 + default-response: *662 application/vnd.github.v3.star+json: schema: type: array - items: &682 + items: &686 title: Starred Repository description: Starred Repository type: object @@ -105639,7 +106294,7 @@ paths: starred_at: type: string format: date-time - repo: *66 + repo: *64 required: - starred_at - repo @@ -105767,7 +106422,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -105787,8 +106442,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: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response if this repository is starred by you @@ -105816,8 +106471,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -105841,8 +106496,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -105875,11 +106530,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -105914,7 +106569,7 @@ paths: application/json: schema: type: array - items: *299 + items: *294 examples: default: value: @@ -105965,7 +106620,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -105992,7 +106647,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *88 + - *85 responses: '200': description: Response @@ -106000,10 +106655,10 @@ paths: application/json: schema: oneOf: - - *632 - - *631 + - *637 + - *636 examples: - default-response: &660 + default-response: &664 summary: Default response value: login: octocat @@ -106038,7 +106693,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &661 + response-with-git-hub-plan-information: &665 summary: Response with GitHub plan information value: login: octocat @@ -106098,7 +106753,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *659 + - *663 - *17 responses: '200': @@ -106109,7 +106764,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: Link: example: ; rel="next" @@ -106139,7 +106794,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *62 + - *57 responses: '200': description: Response @@ -106147,11 +106802,11 @@ paths: application/json: schema: oneOf: - - *632 - - *631 + - *637 + - *636 examples: - default-response: *660 - response-with-git-hub-plan-information: *661 + default-response: *664 + response-with-git-hub-plan-information: *665 '404': *6 x-github: githubCloudOnly: false @@ -106177,7 +106832,7 @@ paths: - *17 - *38 - *39 - - *62 + - *57 requestBody: required: true content: @@ -106200,8 +106855,8 @@ paths: required: - subject_digests examples: - default: *662 - withPredicateType: *663 + default: *666 + withPredicateType: *667 responses: '200': description: Response @@ -106255,7 +106910,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *664 + default: *668 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106273,7 +106928,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *62 + - *57 requestBody: required: true content: @@ -106338,7 +106993,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *62 + - *57 - name: subject_digest description: Subject Digest in: path @@ -106369,7 +107024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *62 + - *57 - name: attestation_id description: Attestation ID in: path @@ -106407,7 +107062,7 @@ paths: - *17 - *38 - *39 - - *62 + - *57 - name: subject_digest description: Subject Digest in: path @@ -106459,12 +107114,12 @@ paths: initiator: type: string examples: - default: *378 + default: *373 '201': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -106490,7 +107145,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: - - *62 + - *57 responses: '200': description: Response @@ -106498,9 +107153,9 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *649 + default: *653 '403': *27 '401': *23 x-github: @@ -106523,7 +107178,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -106533,7 +107188,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -106595,8 +107250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *62 - - *99 + - *57 + - *61 - *17 - *19 responses: @@ -106606,7 +107261,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -106683,7 +107338,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -106693,7 +107348,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -106751,7 +107406,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -106763,9 +107418,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106782,7 +107437,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *62 + - *57 - *17 - *19 responses: @@ -106794,9 +107449,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106813,7 +107468,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *62 + - *57 - name: target_user in: path required: true @@ -106840,8 +107495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *62 - - *75 + - *57 + - *72 - *17 - *19 responses: @@ -106851,11 +107506,11 @@ paths: application/json: schema: type: array - items: *76 + items: *73 examples: - default: *77 + default: *74 headers: - Link: *57 + Link: *52 '422': *15 x-github: githubCloudOnly: false @@ -106874,7 +107529,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -106884,11 +107539,11 @@ paths: application/json: schema: type: array - items: *639 + items: *644 examples: - default: *665 + default: *669 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106910,7 +107565,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *62 + - *57 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -106982,7 +107637,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *62 + - *57 responses: '200': description: Response @@ -106990,7 +107645,7 @@ paths: application/json: schema: *20 examples: - default: *502 + default: *497 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107008,7 +107663,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -107044,7 +107699,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107064,7 +107719,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -107074,11 +107729,11 @@ paths: application/json: schema: type: array - items: *160 + items: *59 examples: - default: *647 + default: *96 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107115,8 +107770,8 @@ paths: - docker - nuget - container - - *648 - - *62 + - *652 + - *57 - *19 - *17 responses: @@ -107126,12 +107781,12 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *649 + default: *653 '403': *27 '401': *23 - '400': *650 + '400': *654 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107151,17 +107806,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *218 - - *219 - - *62 + - *224 + - *225 + - *57 responses: '200': description: Response content: application/json: - schema: *216 + schema: *222 examples: - default: *666 + default: *670 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107182,9 +107837,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *218 - - *219 - - *62 + - *224 + - *225 + - *57 responses: '204': description: Response @@ -107216,9 +107871,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *218 - - *219 - - *62 + - *224 + - *225 + - *57 - name: token description: package token schema: @@ -107250,9 +107905,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: - - *218 - - *219 - - *62 + - *224 + - *225 + - *57 responses: '200': description: Response @@ -107260,7 +107915,7 @@ paths: application/json: schema: type: array - items: *220 + items: *226 examples: default: value: @@ -107318,16 +107973,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *218 - - *219 - - *221 - - *62 + - *224 + - *225 + - *227 + - *57 responses: '200': description: Response content: application/json: - schema: *220 + schema: *226 examples: default: value: @@ -107362,10 +108017,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *218 - - *219 - - *62 - - *221 + - *224 + - *225 + - *57 + - *227 responses: '204': description: Response @@ -107397,10 +108052,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *218 - - *219 - - *62 - - *221 + - *224 + - *225 + - *57 + - *227 responses: '204': description: Response @@ -107426,7 +108081,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-user-projects parameters: - - *62 + - *57 - name: state description: Indicates the state of the projects to return. in: query @@ -107447,7 +108102,7 @@ paths: application/json: schema: type: array - items: *232 + items: *238 examples: default: value: @@ -107483,7 +108138,7 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *57 + Link: *52 '422': *15 x-github: githubCloudOnly: false @@ -107505,7 +108160,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *62 + - *57 - name: q description: Limit results to projects of the specified type. in: query @@ -107522,11 +108177,11 @@ paths: application/json: schema: type: array - items: *233 + items: *239 examples: - default: *234 + default: *240 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107546,18 +108201,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *235 - - *62 + - *241 + - *57 responses: '200': description: Response content: application/json: - schema: *233 + schema: *239 examples: - default: *234 + default: *240 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107577,8 +108232,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *235 - - *62 + - *241 + - *57 - *17 - *38 - *39 @@ -107589,11 +108244,11 @@ paths: application/json: schema: type: array - items: *236 + items: *242 examples: - default: *237 + default: *243 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107613,19 +108268,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *235 - - *667 - - *62 + - *241 + - *671 + - *57 responses: '200': description: Response content: application/json: - schema: *236 + schema: *242 examples: - default: *237 + default: *243 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107646,8 +108301,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *235 - - *62 + - *241 + - *57 - *38 - *39 - *17 @@ -107659,17 +108314,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -107677,11 +108334,11 @@ paths: application/json: schema: type: array - items: *242 + items: *248 examples: - default: *243 + default: *249 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107700,8 +108357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *62 - - *235 + - *57 + - *241 requestBody: required: true description: Details of the item to add to the project. @@ -107738,10 +108395,10 @@ paths: description: Response content: application/json: - schema: *668 + schema: *672 examples: - issue: *241 - pull_request: *241 + issue: *247 + pull_request: *247 '304': *35 '403': *27 '401': *23 @@ -107761,31 +108418,33 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *235 - - *62 - - *244 + - *241 + - *57 + - *250 - 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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *242 + schema: *248 examples: - default: *243 + default: *249 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107804,9 +108463,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *235 - - *62 - - *244 + - *241 + - *57 + - *250 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -107879,13 +108538,13 @@ paths: description: Response content: application/json: - schema: *242 + schema: *248 examples: - text_field: *243 - number_field: *243 - date_field: *243 - single_select_field: *243 - iteration_field: *243 + text_field: *249 + number_field: *249 + date_field: *249 + single_select_field: *249 + iteration_field: *249 '401': *23 '403': *27 '404': *6 @@ -107905,9 +108564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *235 - - *62 - - *244 + - *241 + - *57 + - *250 responses: '204': description: Response @@ -107934,7 +108593,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -107944,7 +108603,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -108009,7 +108668,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -108019,7 +108678,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -108082,7 +108741,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *62 + - *57 - name: type description: Limit results to repositories of the specified type. in: query @@ -108125,11 +108784,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108151,15 +108810,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *62 + - *57 responses: '200': description: Response content: application/json: - schema: *669 + schema: *673 examples: - default: *670 + default: *674 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108181,15 +108840,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *62 + - *57 responses: '200': description: Response content: application/json: - schema: *671 + schema: *675 examples: - default: *672 + default: *676 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108198,7 +108857,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 @@ -108206,12 +108868,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: - - *62 + - *57 + - *100 + - *677 - *101 - - *673 - - *102 - - *674 - - *675 + - *678 + - *679 responses: '200': description: Response when getting a billing premium request usage report @@ -108264,19 +108926,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 @@ -108318,8 +108980,8 @@ paths: '400': *14 '403': *27 '404': *6 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108341,15 +109003,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *62 + - *57 responses: '200': description: Response content: application/json: - schema: *676 + schema: *680 examples: - default: *677 + default: *681 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108369,11 +109031,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *62 + - *57 + - *100 + - *682 - *101 - - *678 - - *102 - - *679 + - *683 responses: '200': description: Response when getting a billing usage report @@ -108443,8 +109105,8 @@ paths: repositoryName: user/example '400': *14 '403': *27 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108462,7 +109124,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -108472,11 +109134,11 @@ paths: application/json: schema: type: array - items: *653 + items: *657 examples: - default: *654 + default: *658 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108494,7 +109156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -108504,11 +109166,11 @@ paths: application/json: schema: type: array - items: *655 + items: *659 examples: - default: *680 + default: *684 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108530,8 +109192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *62 - - *681 + - *57 + - *685 - *46 - *17 - *19 @@ -108543,13 +109205,13 @@ paths: schema: anyOf: - type: array - items: *682 + items: *686 - type: array - items: *66 + items: *64 examples: - default-response: *658 + default-response: *662 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108566,7 +109228,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -108576,11 +109238,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108707,7 +109369,7 @@ webhooks: type: string enum: - disabled - enterprise: &683 + enterprise: &687 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -108776,7 +109438,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &684 + installation: &688 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -108797,7 +109459,7 @@ webhooks: required: - id - node_id - organization: &685 + organization: &689 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -108870,7 +109532,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &686 + repository: &690 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -108899,7 +109561,7 @@ webhooks: license: anyOf: - type: 'null' - - *71 + - *69 organization: anyOf: - type: 'null' @@ -109783,10 +110445,10 @@ webhooks: type: string enum: - enabled - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -109862,11 +110524,11 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - rule: &687 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + rule: &691 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) @@ -110089,11 +110751,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - rule: *687 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + rule: *691 sender: *4 required: - action @@ -110281,11 +110943,11 @@ webhooks: - everyone required: - from - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - rule: *687 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + rule: *691 sender: *4 required: - action @@ -110369,7 +111031,7 @@ webhooks: type: string enum: - completed - check_run: &689 + check_run: &693 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110434,8 +111096,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *72 - repository: *131 + items: *70 + repository: *135 status: type: string enum: @@ -110479,7 +111141,7 @@ webhooks: - examples: - neutral - deployment: *688 + deployment: *692 details_url: type: string examples: @@ -110539,7 +111201,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *72 + items: *70 started_at: type: string format: date-time @@ -110577,10 +111239,10 @@ webhooks: - output - app - pull_requests - installation: *684 - enterprise: *683 - organization: *685 - repository: *686 + installation: *688 + enterprise: *687 + organization: *689 + repository: *690 sender: *4 required: - check_run @@ -110973,11 +111635,11 @@ webhooks: type: string enum: - created - check_run: *689 - installation: *684 - enterprise: *683 - organization: *685 - repository: *686 + check_run: *693 + installation: *688 + enterprise: *687 + organization: *689 + repository: *690 sender: *4 required: - check_run @@ -111373,11 +112035,11 @@ webhooks: type: string enum: - requested_action - check_run: *689 - installation: *684 - enterprise: *683 - organization: *685 - repository: *686 + check_run: *693 + installation: *688 + enterprise: *687 + organization: *689 + repository: *690 requested_action: description: The action requested by the user. type: object @@ -111782,11 +112444,11 @@ webhooks: type: string enum: - rerequested - check_run: *689 - installation: *684 - enterprise: *683 - organization: *685 - repository: *686 + check_run: *693 + installation: *688 + enterprise: *687 + organization: *689 + repository: *690 sender: *4 required: - check_run @@ -112778,10 +113440,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -113466,10 +114128,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -114148,10 +114810,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -114320,7 +114982,7 @@ webhooks: required: - login - id - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114472,20 +115134,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &690 + commit_oid: &694 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: *683 - installation: *684 - organization: *685 - ref: &691 + enterprise: *687 + installation: *688 + organization: *689 + ref: &695 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: *686 + repository: *690 sender: *4 required: - action @@ -114652,7 +115314,7 @@ webhooks: required: - login - id - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114893,12 +115555,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *690 - enterprise: *683 - installation: *684 - organization: *685 - ref: *691 - repository: *686 + commit_oid: *694 + enterprise: *687 + installation: *688 + organization: *689 + ref: *695 + repository: *690 sender: *4 required: - action @@ -114996,7 +115658,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115181,12 +115843,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *690 - enterprise: *683 - installation: *684 - organization: *685 - ref: *691 - repository: *686 + commit_oid: *694 + enterprise: *687 + installation: *688 + organization: *689 + ref: *695 + repository: *690 sender: *4 required: - action @@ -115355,7 +116017,7 @@ webhooks: required: - login - id - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -115532,12 +116194,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *690 - enterprise: *683 - installation: *684 - organization: *685 - ref: *691 - repository: *686 + commit_oid: *694 + enterprise: *687 + installation: *688 + organization: *689 + ref: *695 + repository: *690 sender: *4 required: - action @@ -115640,7 +116302,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115820,9 +116482,9 @@ webhooks: type: - string - 'null' - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -115830,7 +116492,7 @@ webhooks: type: - string - 'null' - repository: *686 + repository: *690 sender: *4 required: - action @@ -115929,7 +116591,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116076,12 +116738,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *690 - enterprise: *683 - installation: *684 - organization: *685 - ref: *691 - repository: *686 + commit_oid: *694 + enterprise: *687 + installation: *688 + organization: *689 + ref: *695 + repository: *690 sender: *4 required: - action @@ -116343,10 +117005,10 @@ webhooks: - updated_at - author_association - body - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -116427,18 +117089,18 @@ webhooks: type: - string - 'null' - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *685 - pusher_type: &692 + organization: *689 + pusher_type: &696 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &693 + ref: &697 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -116448,7 +117110,7 @@ webhooks: enum: - tag - branch - repository: *686 + repository: *690 sender: *4 required: - ref @@ -116530,10 +117192,10 @@ webhooks: type: string enum: - created - definition: *245 - enterprise: *683 - installation: *684 - organization: *685 + definition: *251 + enterprise: *687 + installation: *688 + organization: *689 sender: *4 required: - action @@ -116618,9 +117280,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 sender: *4 required: - action @@ -116697,10 +117359,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *245 - enterprise: *683 - installation: *684 - organization: *685 + definition: *251 + enterprise: *687 + installation: *688 + organization: *689 sender: *4 required: - action @@ -116777,10 +117439,10 @@ webhooks: type: string enum: - updated - definition: *245 - enterprise: *683 - installation: *684 - organization: *685 + definition: *251 + enterprise: *687 + installation: *688 + organization: *689 sender: *4 required: - action @@ -116857,19 +117519,19 @@ webhooks: type: string enum: - updated - enterprise: *683 - installation: *684 - repository: *686 - organization: *685 + enterprise: *687 + installation: *688 + repository: *690 + organization: *689 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *249 + items: *97 old_property_values: type: array description: The old custom property values for the repository. - items: *249 + items: *97 required: - action - repository @@ -116945,18 +117607,18 @@ webhooks: title: delete event type: object properties: - enterprise: *683 - installation: *684 - organization: *685 - pusher_type: *692 - ref: *693 + enterprise: *687 + installation: *688 + organization: *689 + pusher_type: *696 + ref: *697 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *686 + repository: *690 sender: *4 required: - ref @@ -117040,11 +117702,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117128,11 +117790,11 @@ webhooks: type: string enum: - auto_reopened - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117216,11 +117878,11 @@ webhooks: type: string enum: - created - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117302,11 +117964,11 @@ webhooks: type: string enum: - dismissed - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117388,11 +118050,11 @@ webhooks: type: string enum: - fixed - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117475,11 +118137,11 @@ webhooks: type: string enum: - reintroduced - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117561,11 +118223,11 @@ webhooks: type: string enum: - reopened - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117642,9 +118304,9 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - key: &694 + enterprise: *687 + installation: *688 + key: &698 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -117682,8 +118344,8 @@ webhooks: - verified - created_at - read_only - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -117760,11 +118422,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - key: *694 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + key: *698 + organization: *689 + repository: *690 sender: *4 required: - action @@ -118336,12 +118998,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - workflow: &698 + workflow: &702 title: Workflow type: - object @@ -119079,13 +119741,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *467 + deployment: *462 pull_requests: type: array - items: *547 - repository: *686 - organization: *685 - installation: *684 + items: *544 + repository: *690 + organization: *689 + installation: *688 sender: *4 responses: '200': @@ -119156,7 +119818,7 @@ webhooks: type: string enum: - approved - approver: &695 + approver: &699 type: object properties: avatar_url: @@ -119199,11 +119861,11 @@ webhooks: type: string comment: type: string - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - reviewers: &696 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + reviewers: &700 type: array items: type: object @@ -119284,7 +119946,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &697 + workflow_job_run: &701 type: object properties: conclusion: @@ -120030,18 +120692,18 @@ webhooks: type: string enum: - rejected - approver: *695 + approver: *699 comment: type: string - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - reviewers: *696 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + reviewers: *700 sender: *4 since: type: string - workflow_job_run: *697 + workflow_job_run: *701 workflow_job_runs: type: array items: @@ -120758,13 +121420,13 @@ webhooks: type: string enum: - requested - enterprise: *683 + enterprise: *687 environment: type: string - installation: *684 - organization: *685 - repository: *686 - requestor: &703 + installation: *688 + organization: *689 + repository: *690 + requestor: &707 title: User type: - object @@ -122707,12 +123369,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - workflow: *698 + workflow: *702 workflow_run: title: Deployment Workflow Run type: @@ -123403,7 +124065,7 @@ webhooks: type: string enum: - answered - answer: &701 + answer: &705 type: object properties: author_association: @@ -123563,11 +124225,11 @@ webhooks: - created_at - updated_at - body - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -123694,11 +124356,11 @@ webhooks: - from required: - category - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -123781,11 +124443,11 @@ webhooks: type: string enum: - closed - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -123867,7 +124529,7 @@ webhooks: type: string enum: - created - comment: &700 + comment: &704 type: object properties: author_association: @@ -124027,11 +124689,11 @@ webhooks: - updated_at - body - reactions - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124114,12 +124776,12 @@ webhooks: type: string enum: - deleted - comment: *700 - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + comment: *704 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124214,12 +124876,12 @@ webhooks: - from required: - body - comment: *700 - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + comment: *704 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124303,11 +124965,11 @@ webhooks: type: string enum: - created - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124389,11 +125051,11 @@ webhooks: type: string enum: - deleted - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124493,11 +125155,11 @@ webhooks: type: string required: - from - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124579,10 +125241,10 @@ webhooks: type: string enum: - labeled - discussion: *699 - enterprise: *683 - installation: *684 - label: &702 + discussion: *703 + enterprise: *687 + installation: *688 + label: &706 title: Label type: object properties: @@ -124615,8 +125277,8 @@ webhooks: - color - default - description - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124699,11 +125361,11 @@ webhooks: type: string enum: - locked - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124785,11 +125447,11 @@ webhooks: type: string enum: - pinned - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124871,11 +125533,11 @@ webhooks: type: string enum: - reopened - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124960,16 +125622,16 @@ webhooks: changes: type: object properties: - new_discussion: *699 - new_repository: *686 + new_discussion: *703 + new_repository: *690 required: - new_discussion - new_repository - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -125052,10 +125714,10 @@ webhooks: type: string enum: - unanswered - discussion: *699 - old_answer: *701 - organization: *685 - repository: *686 + discussion: *703 + old_answer: *705 + organization: *689 + repository: *690 sender: *4 required: - action @@ -125137,12 +125799,12 @@ webhooks: type: string enum: - unlabeled - discussion: *699 - enterprise: *683 - installation: *684 - label: *702 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -125225,11 +125887,11 @@ webhooks: type: string enum: - unlocked - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -125311,11 +125973,11 @@ webhooks: type: string enum: - unpinned - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -125388,7 +126050,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *683 + enterprise: *687 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -126066,9 +126728,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *684 - organization: *685 - repository: *686 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - forkee @@ -126214,9 +126876,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pages: description: The pages that were updated. type: array @@ -126254,7 +126916,7 @@ webhooks: - action - sha - html_url - repository: *686 + repository: *690 sender: *4 required: - pages @@ -126330,10 +126992,10 @@ webhooks: type: string enum: - created - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories: &704 + organization: *689 + repositories: &708 description: An array of repository objects that the installation can access. type: array @@ -126359,8 +127021,8 @@ webhooks: - name - full_name - private - repository: *686 - requester: *703 + repository: *690 + requester: *707 sender: *4 required: - action @@ -126435,11 +127097,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories: *704 - repository: *686 + organization: *689 + repositories: *708 + repository: *690 requester: type: - 'null' @@ -126516,11 +127178,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories: *704 - repository: *686 + organization: *689 + repositories: *708 + repository: *690 requester: type: - 'null' @@ -126597,10 +127259,10 @@ webhooks: type: string enum: - added - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories_added: &705 + organization: *689 + repositories_added: &709 description: An array of repository objects, which were added to the installation. type: array @@ -126646,15 +127308,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *686 - repository_selection: &706 + repository: *690 + repository_selection: &710 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *703 + requester: *707 sender: *4 required: - action @@ -126733,10 +127395,10 @@ webhooks: type: string enum: - removed - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories_added: *705 + organization: *689 + repositories_added: *709 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -126763,9 +127425,9 @@ webhooks: - name - full_name - private - repository: *686 - repository_selection: *706 - requester: *703 + repository: *690 + repository_selection: *710 + requester: *707 sender: *4 required: - action @@ -126844,11 +127506,11 @@ webhooks: type: string enum: - suspend - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories: *704 - repository: *686 + organization: *689 + repositories: *708 + repository: *690 requester: type: - 'null' @@ -127030,10 +127692,10 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 target_type: type: string @@ -127112,11 +127774,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories: *704 - repository: *686 + organization: *689 + repositories: *708 + repository: *690 requester: type: - 'null' @@ -127364,8 +128026,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128182,8 +128844,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128200,7 +128862,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -128544,8 +129206,8 @@ webhooks: - state - locked - assignee - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -128625,7 +129287,7 @@ webhooks: type: string enum: - deleted - comment: &707 + comment: &711 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -128792,8 +129454,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129606,8 +130268,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129624,7 +130286,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -129970,8 +130632,8 @@ webhooks: - state - locked - assignee - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -130051,7 +130713,7 @@ webhooks: type: string enum: - edited - changes: &731 + changes: &735 description: The changes to the comment. type: object properties: @@ -130063,9 +130725,9 @@ webhooks: type: string required: - from - comment: *707 - enterprise: *683 - installation: *684 + comment: *711 + enterprise: *687 + installation: *688 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -130881,8 +131543,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130899,7 +131561,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -131243,8 +131905,8 @@ webhooks: - state - locked - assignee - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -131328,15 +131990,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *68 + blocked_issue: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *68 - blocking_issue_repo: *66 - installation: *684 - organization: *685 - repository: *686 + blocking_issue: *66 + blocking_issue_repo: *64 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -131424,15 +132086,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *68 + blocked_issue: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *68 - blocking_issue_repo: *66 - installation: *684 - organization: *685 - repository: *686 + blocking_issue: *66 + blocking_issue_repo: *64 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -131519,15 +132181,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *68 - blocked_issue_repo: *66 + blocked_issue: *66 + blocked_issue_repo: *64 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *68 - installation: *684 - organization: *685 - repository: *686 + blocking_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -131615,15 +132277,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *68 - blocked_issue_repo: *66 + blocked_issue: *66 + blocked_issue_repo: *64 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *68 - installation: *684 - organization: *685 - repository: *686 + blocking_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -131708,10 +132370,10 @@ webhooks: type: string enum: - assigned - assignee: *703 - enterprise: *683 - installation: *684 - issue: &710 + assignee: *707 + enterprise: *687 + installation: *688 + issue: &714 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -132523,11 +133185,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132544,7 +133206,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -132647,8 +133309,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -132728,8 +133390,8 @@ webhooks: type: string enum: - closed - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -133546,11 +134208,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133567,7 +134229,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -133813,8 +134475,8 @@ webhooks: required: - state - closed_at - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -133893,8 +134555,8 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134702,11 +135364,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134723,7 +135385,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -134825,8 +135487,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -134905,8 +135567,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135737,11 +136399,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135758,7 +136420,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -135839,7 +136501,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &708 + milestone: &712 title: Milestone description: A collection of related issues and pull requests. type: object @@ -135982,8 +136644,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -136082,8 +136744,8 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136895,11 +137557,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136913,7 +137575,7 @@ webhooks: timeline_url: type: string format: uri - type: *199 + type: *205 title: description: Title of the issue type: string @@ -137019,9 +137681,9 @@ webhooks: - active_lock_reason - body - reactions - label: *702 - organization: *685 - repository: *686 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -137101,8 +137763,8 @@ webhooks: type: string enum: - labeled - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137913,11 +138575,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137931,7 +138593,7 @@ webhooks: timeline_url: type: string format: uri - type: *199 + type: *205 title: description: Title of the issue type: string @@ -138037,9 +138699,9 @@ webhooks: - active_lock_reason - body - reactions - label: *702 - organization: *685 - repository: *686 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -138119,8 +138781,8 @@ webhooks: type: string enum: - locked - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138956,11 +139618,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138974,7 +139636,7 @@ webhooks: timeline_url: type: string format: uri - type: *199 + type: *205 title: description: Title of the issue type: string @@ -139057,8 +139719,8 @@ webhooks: format: uri user_view_type: type: string - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -139137,8 +139799,8 @@ webhooks: type: string enum: - milestoned - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139968,11 +140630,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139989,7 +140651,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -140069,9 +140731,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *708 - organization: *685 - repository: *686 + milestone: *712 + organization: *689 + repository: *690 sender: *4 required: - action @@ -140963,11 +141625,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141063,7 +141725,7 @@ webhooks: required: - login - id - type: *199 + type: *205 required: - id - number @@ -141544,8 +142206,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142357,11 +143019,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142378,7 +143040,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -142480,8 +143142,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -142561,9 +143223,9 @@ webhooks: type: string enum: - pinned - enterprise: *683 - installation: *684 - issue: &709 + enterprise: *687 + installation: *688 + issue: &713 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -143369,11 +144031,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143390,7 +144052,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -143492,8 +144154,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -143572,8 +144234,8 @@ webhooks: type: string enum: - reopened - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144407,11 +145069,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144508,9 +145170,9 @@ webhooks: format: uri user_view_type: type: string - type: *199 - organization: *685 - repository: *686 + type: *205 + organization: *689 + repository: *690 sender: *4 required: - action @@ -145399,11 +146061,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145420,7 +146082,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -146002,11 +146664,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *683 - installation: *684 - issue: *709 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *713 + organization: *689 + repository: *690 sender: *4 required: - action @@ -146086,12 +146748,12 @@ webhooks: type: string enum: - typed - enterprise: *683 - installation: *684 - issue: *710 - type: *199 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *714 + type: *205 + organization: *689 + repository: *690 sender: *4 required: - action @@ -146172,7 +146834,7 @@ webhooks: type: string enum: - unassigned - assignee: &734 + assignee: &738 title: User type: - object @@ -146244,11 +146906,11 @@ webhooks: required: - login - id - enterprise: *683 - installation: *684 - issue: *710 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *714 + organization: *689 + repository: *690 sender: *4 required: - action @@ -146327,12 +146989,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *683 - installation: *684 - issue: *710 - label: *702 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *714 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -146412,8 +147074,8 @@ webhooks: type: string enum: - unlocked - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147247,11 +147909,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147268,7 +147930,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -147348,8 +148010,8 @@ webhooks: format: uri user_view_type: type: string - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147429,11 +148091,11 @@ webhooks: type: string enum: - unpinned - enterprise: *683 - installation: *684 - issue: *709 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *713 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147512,12 +148174,12 @@ webhooks: type: string enum: - untyped - enterprise: *683 - installation: *684 - issue: *710 - type: *199 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *714 + type: *205 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147597,11 +148259,11 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - label: *702 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147679,11 +148341,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - label: *702 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147793,11 +148455,11 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - label: *702 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147879,9 +148541,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *683 - installation: *684 - marketplace_purchase: &711 + enterprise: *687 + installation: *688 + marketplace_purchase: &715 title: Marketplace Purchase type: object required: @@ -147969,8 +148631,8 @@ webhooks: type: integer unit_count: type: integer - organization: *685 - previous_marketplace_purchase: &712 + organization: *689 + previous_marketplace_purchase: &716 title: Marketplace Purchase type: object properties: @@ -148054,7 +148716,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *686 + repository: *690 sender: *4 required: - action @@ -148134,10 +148796,10 @@ webhooks: - changed effective_date: type: string - enterprise: *683 - installation: *684 - marketplace_purchase: *711 - organization: *685 + enterprise: *687 + installation: *688 + marketplace_purchase: *715 + organization: *689 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148225,7 +148887,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *686 + repository: *690 sender: *4 required: - action @@ -148307,10 +148969,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *683 - installation: *684 - marketplace_purchase: *711 - organization: *685 + enterprise: *687 + installation: *688 + marketplace_purchase: *715 + organization: *689 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148396,7 +149058,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *686 + repository: *690 sender: *4 required: - action @@ -148477,8 +149139,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 marketplace_purchase: title: Marketplace Purchase type: object @@ -148564,9 +149226,9 @@ webhooks: type: integer unit_count: type: integer - organization: *685 - previous_marketplace_purchase: *712 - repository: *686 + organization: *689 + previous_marketplace_purchase: *716 + repository: *690 sender: *4 required: - action @@ -148646,12 +149308,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *683 - installation: *684 - marketplace_purchase: *711 - organization: *685 - previous_marketplace_purchase: *712 - repository: *686 + enterprise: *687 + installation: *688 + marketplace_purchase: *715 + organization: *689 + previous_marketplace_purchase: *716 + repository: *690 sender: *4 required: - action @@ -148753,11 +149415,11 @@ webhooks: type: string required: - to - enterprise: *683 - installation: *684 - member: *703 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + member: *707 + organization: *689 + repository: *690 sender: *4 required: - action @@ -148859,11 +149521,11 @@ webhooks: type: - string - 'null' - enterprise: *683 - installation: *684 - member: *703 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + member: *707 + organization: *689 + repository: *690 sender: *4 required: - action @@ -148942,11 +149604,11 @@ webhooks: type: string enum: - removed - enterprise: *683 - installation: *684 - member: *703 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + member: *707 + organization: *689 + repository: *690 sender: *4 required: - action @@ -149024,11 +149686,11 @@ webhooks: type: string enum: - added - enterprise: *683 - installation: *684 - member: *703 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + member: *707 + organization: *689 + repository: *690 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149106,7 +149768,7 @@ webhooks: required: - login - id - team: &713 + team: &717 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -149336,11 +149998,11 @@ webhooks: type: string enum: - removed - enterprise: *683 - installation: *684 - member: *703 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + member: *707 + organization: *689 + repository: *690 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149419,7 +150081,7 @@ webhooks: required: - login - id - team: *713 + team: *717 required: - action - scope @@ -149501,8 +150163,8 @@ webhooks: type: string enum: - checks_requested - installation: *684 - merge_group: &714 + installation: *688 + merge_group: &718 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -149521,15 +150183,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *398 + head_commit: *393 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -149615,10 +150277,10 @@ webhooks: - merged - invalidated - dequeued - installation: *684 - merge_group: *714 - organization: *685 - repository: *686 + installation: *688 + merge_group: *718 + organization: *689 + repository: *690 sender: *4 required: - action @@ -149691,7 +150353,7 @@ webhooks: type: string enum: - deleted - enterprise: *683 + enterprise: *687 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -149800,12 +150462,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *684 - organization: *685 + installation: *688 + organization: *689 repository: anyOf: - type: 'null' - - *686 + - *690 sender: *4 required: - action @@ -149885,11 +150547,11 @@ webhooks: type: string enum: - closed - enterprise: *683 - installation: *684 - milestone: *708 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + milestone: *712 + organization: *689 + repository: *690 sender: *4 required: - action @@ -149968,9 +150630,9 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - milestone: &715 + enterprise: *687 + installation: *688 + milestone: &719 title: Milestone description: A collection of related issues and pull requests. type: object @@ -150112,8 +150774,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150192,11 +150854,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - milestone: *708 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + milestone: *712 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150306,11 +150968,11 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - milestone: *708 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + milestone: *712 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150390,11 +151052,11 @@ webhooks: type: string enum: - opened - enterprise: *683 - installation: *684 - milestone: *715 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + milestone: *719 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150473,11 +151135,11 @@ webhooks: type: string enum: - blocked - blocked_user: *703 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + blocked_user: *707 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150556,11 +151218,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *703 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + blocked_user: *707 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150639,9 +151301,9 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - membership: &716 + enterprise: *687 + installation: *688 + membership: &720 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -150751,8 +151413,8 @@ webhooks: - role - organization_url - user - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150830,11 +151492,11 @@ webhooks: type: string enum: - member_added - enterprise: *683 - installation: *684 - membership: *716 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + membership: *720 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150913,8 +151575,8 @@ webhooks: type: string enum: - member_invited - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -151036,10 +151698,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 - user: *703 + user: *707 required: - action - invitation @@ -151117,11 +151779,11 @@ webhooks: type: string enum: - member_removed - enterprise: *683 - installation: *684 - membership: *716 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + membership: *720 + organization: *689 + repository: *690 sender: *4 required: - action @@ -151208,11 +151870,11 @@ webhooks: properties: from: type: string - enterprise: *683 - installation: *684 - membership: *716 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + membership: *720 + organization: *689 + repository: *690 sender: *4 required: - action @@ -151288,9 +151950,9 @@ webhooks: type: string enum: - published - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 package: description: Information about the package. type: object @@ -151813,7 +152475,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &717 + items: &721 title: Ruby Gems metadata type: object properties: @@ -151910,7 +152572,7 @@ webhooks: - owner - package_version - registry - repository: *686 + repository: *690 sender: *4 required: - action @@ -151986,9 +152648,9 @@ webhooks: type: string enum: - updated - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 package: description: Information about the package. type: object @@ -152350,7 +153012,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *717 + items: *721 source_url: type: string format: uri @@ -152421,7 +153083,7 @@ webhooks: - owner - package_version - registry - repository: *686 + repository: *690 sender: *4 required: - action @@ -152602,12 +153264,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *683 + enterprise: *687 id: type: integer - installation: *684 - organization: *685 - repository: *686 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - id @@ -152684,7 +153346,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &718 + personal_access_token_request: &722 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -152834,10 +153496,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *683 - organization: *685 + enterprise: *687 + organization: *689 sender: *4 - installation: *684 + installation: *688 required: - action - personal_access_token_request @@ -152914,11 +153576,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *718 - enterprise: *683 - organization: *685 + personal_access_token_request: *722 + enterprise: *687 + organization: *689 sender: *4 - installation: *684 + installation: *688 required: - action - personal_access_token_request @@ -152994,11 +153656,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *718 - enterprise: *683 - organization: *685 + personal_access_token_request: *722 + enterprise: *687 + organization: *689 sender: *4 - installation: *684 + installation: *688 required: - action - personal_access_token_request @@ -153073,11 +153735,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *718 - organization: *685 - enterprise: *683 + personal_access_token_request: *722 + organization: *689 + enterprise: *687 sender: *4 - installation: *684 + installation: *688 required: - action - personal_access_token_request @@ -153182,7 +153844,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *719 + last_response: *723 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -153214,8 +153876,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 zen: description: Random string of GitHub zen. @@ -153460,10 +154122,10 @@ webhooks: - from required: - note - enterprise: *683 - installation: *684 - organization: *685 - project_card: &720 + enterprise: *687 + installation: *688 + organization: *689 + project_card: &724 title: Project Card type: object properties: @@ -153586,7 +154248,7 @@ webhooks: - creator - created_at - updated_at - repository: *686 + repository: *690 sender: *4 required: - action @@ -153667,11 +154329,11 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - project_card: *720 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project_card: *724 + repository: *690 sender: *4 required: - action @@ -153751,9 +154413,9 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 project_card: title: Project Card type: object @@ -153883,7 +154545,7 @@ webhooks: repository: anyOf: - type: 'null' - - *686 + - *690 sender: *4 required: - action @@ -153977,11 +154639,11 @@ webhooks: - from required: - note - enterprise: *683 - installation: *684 - organization: *685 - project_card: *720 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project_card: *724 + repository: *690 sender: *4 required: - action @@ -154075,9 +154737,9 @@ webhooks: - from required: - column_id - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 project_card: allOf: - title: Project Card @@ -154274,7 +154936,7 @@ webhooks: type: string required: - after_id - repository: *686 + repository: *690 sender: *4 required: - action @@ -154354,10 +155016,10 @@ webhooks: type: string enum: - closed - enterprise: *683 - installation: *684 - organization: *685 - project: &722 + enterprise: *687 + installation: *688 + organization: *689 + project: &726 title: Project type: object properties: @@ -154484,7 +155146,7 @@ webhooks: - creator - created_at - updated_at - repository: *686 + repository: *690 sender: *4 required: - action @@ -154564,10 +155226,10 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - project_column: &721 + enterprise: *687 + installation: *688 + organization: *689 + project_column: &725 title: Project Column type: object properties: @@ -154607,7 +155269,7 @@ webhooks: - name - created_at - updated_at - repository: *686 + repository: *690 sender: *4 required: - action @@ -154686,14 +155348,14 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - project_column: *721 + enterprise: *687 + installation: *688 + organization: *689 + project_column: *725 repository: anyOf: - type: 'null' - - *686 + - *690 sender: *4 required: - action @@ -154782,11 +155444,11 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - organization: *685 - project_column: *721 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project_column: *725 + repository: *690 sender: *4 required: - action @@ -154866,11 +155528,11 @@ webhooks: type: string enum: - moved - enterprise: *683 - installation: *684 - organization: *685 - project_column: *721 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project_column: *725 + repository: *690 sender: *4 required: - action @@ -154950,11 +155612,11 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - project: *722 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project: *726 + repository: *690 sender: *4 required: - action @@ -155034,14 +155696,14 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - project: *722 + enterprise: *687 + installation: *688 + organization: *689 + project: *726 repository: anyOf: - type: 'null' - - *686 + - *690 sender: *4 required: - action @@ -155142,11 +155804,11 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - organization: *685 - project: *722 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project: *726 + repository: *690 sender: *4 required: - action @@ -155225,11 +155887,11 @@ webhooks: type: string enum: - reopened - enterprise: *683 - installation: *684 - organization: *685 - project: *722 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project: *726 + repository: *690 sender: *4 required: - action @@ -155310,9 +155972,9 @@ webhooks: type: string enum: - closed - installation: *684 - organization: *685 - projects_v2: *233 + installation: *688 + organization: *689 + projects_v2: *239 sender: *4 required: - action @@ -155393,9 +156055,9 @@ webhooks: type: string enum: - created - installation: *684 - organization: *685 - projects_v2: *233 + installation: *688 + organization: *689 + projects_v2: *239 sender: *4 required: - action @@ -155476,9 +156138,9 @@ webhooks: type: string enum: - deleted - installation: *684 - organization: *685 - projects_v2: *233 + installation: *688 + organization: *689 + projects_v2: *239 sender: *4 required: - action @@ -155599,9 +156261,9 @@ webhooks: type: string to: type: string - installation: *684 - organization: *685 - projects_v2: *233 + installation: *688 + organization: *689 + projects_v2: *239 sender: *4 required: - action @@ -155684,7 +156346,7 @@ webhooks: type: string enum: - archived - changes: &726 + changes: &730 type: object properties: archived_at: @@ -155700,9 +156362,9 @@ webhooks: - string - 'null' format: date-time - installation: *684 - organization: *685 - projects_v2_item: &723 + installation: *688 + organization: *689 + projects_v2_item: &727 title: Projects v2 Item description: An item belonging to a project type: object @@ -155720,7 +156382,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *240 + content_type: *246 creator: *4 created_at: type: string @@ -155842,9 +156504,9 @@ webhooks: - 'null' to: type: string - installation: *684 - organization: *685 - projects_v2_item: *723 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -155926,9 +156588,9 @@ webhooks: type: string enum: - created - installation: *684 - organization: *685 - projects_v2_item: *723 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -156009,9 +156671,9 @@ webhooks: type: string enum: - deleted - installation: *684 - organization: *685 - projects_v2_item: *723 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -156116,7 +156778,7 @@ webhooks: oneOf: - type: string - type: integer - - &724 + - &728 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -156140,7 +156802,7 @@ webhooks: required: - id - name - - &725 + - &729 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -156180,8 +156842,8 @@ webhooks: oneOf: - type: string - type: integer - - *724 - - *725 + - *728 + - *729 type: - 'null' - string @@ -156204,9 +156866,9 @@ webhooks: - 'null' required: - body - installation: *684 - organization: *685 - projects_v2_item: *723 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -156303,9 +156965,9 @@ webhooks: type: - string - 'null' - installation: *684 - organization: *685 - projects_v2_item: *723 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -156388,10 +157050,10 @@ webhooks: type: string enum: - restored - changes: *726 - installation: *684 - organization: *685 - projects_v2_item: *723 + changes: *730 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -156473,9 +157135,9 @@ webhooks: type: string enum: - reopened - installation: *684 - organization: *685 - projects_v2: *233 + installation: *688 + organization: *689 + projects_v2: *239 sender: *4 required: - action @@ -156556,9 +157218,9 @@ webhooks: type: string enum: - created - installation: *684 - organization: *685 - projects_v2_status_update: *727 + installation: *688 + organization: *689 + projects_v2_status_update: *731 sender: *4 required: - action @@ -156639,9 +157301,9 @@ webhooks: type: string enum: - deleted - installation: *684 - organization: *685 - projects_v2_status_update: *727 + installation: *688 + organization: *689 + projects_v2_status_update: *731 sender: *4 required: - action @@ -156787,9 +157449,9 @@ webhooks: - string - 'null' format: date - installation: *684 - organization: *685 - projects_v2_status_update: *727 + installation: *688 + organization: *689 + projects_v2_status_update: *731 sender: *4 required: - action @@ -156860,10 +157522,10 @@ webhooks: title: public event type: object properties: - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - repository @@ -156940,13 +157602,13 @@ webhooks: type: string enum: - assigned - assignee: *703 - enterprise: *683 - installation: *684 - number: &728 + assignee: *707 + enterprise: *687 + installation: *688 + number: &732 description: The pull request number. type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -159295,7 +159957,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -159377,11 +160039,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -161723,7 +162385,7 @@ webhooks: - draft reason: type: string - repository: *686 + repository: *690 sender: *4 required: - action @@ -161805,11 +162467,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -164151,7 +164813,7 @@ webhooks: - draft reason: type: string - repository: *686 + repository: *690 sender: *4 required: - action @@ -164233,13 +164895,13 @@ webhooks: type: string enum: - closed - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: &729 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: &733 allOf: - - *547 + - *544 - type: object properties: allow_auto_merge: @@ -164301,7 +164963,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *686 + repository: *690 sender: *4 required: - action @@ -164382,12 +165044,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: *729 - repository: *686 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: *733 + repository: *690 sender: *4 required: - action @@ -164467,11 +165129,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *683 - milestone: *238 - number: *728 - organization: *685 - pull_request: &730 + enterprise: *687 + milestone: *244 + number: *732 + organization: *689 + pull_request: &734 title: Pull Request type: object properties: @@ -166798,7 +167460,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -166877,11 +167539,11 @@ webhooks: type: string enum: - dequeued - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -169227,7 +169889,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *686 + repository: *690 sender: *4 required: - action @@ -169351,12 +170013,12 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: *729 - repository: *686 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: *733 + repository: *690 sender: *4 required: - action @@ -169436,11 +170098,11 @@ webhooks: type: string enum: - enqueued - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -171771,7 +172433,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -171851,11 +172513,11 @@ webhooks: type: string enum: - labeled - enterprise: *683 - installation: *684 - label: *702 - number: *728 - organization: *685 + enterprise: *687 + installation: *688 + label: *706 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -174203,7 +174865,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -174284,10 +174946,10 @@ webhooks: type: string enum: - locked - enterprise: *683 - installation: *684 - number: *728 - organization: *685 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -176633,7 +177295,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -176713,12 +177375,12 @@ webhooks: type: string enum: - milestoned - enterprise: *683 - milestone: *238 - number: *728 - organization: *685 - pull_request: *730 - repository: *686 + enterprise: *687 + milestone: *244 + number: *732 + organization: *689 + pull_request: *734 + repository: *690 sender: *4 required: - action @@ -176797,12 +177459,12 @@ webhooks: type: string enum: - opened - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: *729 - repository: *686 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: *733 + repository: *690 sender: *4 required: - action @@ -176883,12 +177545,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: *729 - repository: *686 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: *733 + repository: *690 sender: *4 required: - action @@ -176968,12 +177630,12 @@ webhooks: type: string enum: - reopened - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: *729 - repository: *686 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: *733 + repository: *690 sender: *4 required: - action @@ -177348,9 +178010,9 @@ webhooks: - start_side - side - reactions - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: type: object properties: @@ -179580,7 +180242,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *686 + repository: *690 sender: *4 required: - action @@ -179660,7 +180322,7 @@ webhooks: type: string enum: - deleted - comment: &732 + comment: &736 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -179953,9 +180615,9 @@ webhooks: - start_side - side - reactions - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: type: object properties: @@ -182173,7 +182835,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *686 + repository: *690 sender: *4 required: - action @@ -182253,11 +182915,11 @@ webhooks: type: string enum: - edited - changes: *731 - comment: *732 - enterprise: *683 - installation: *684 - organization: *685 + changes: *735 + comment: *736 + enterprise: *687 + installation: *688 + organization: *689 pull_request: type: object properties: @@ -184478,7 +185140,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *686 + repository: *690 sender: *4 required: - action @@ -184559,9 +185221,9 @@ webhooks: type: string enum: - dismissed - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: title: Simple Pull Request type: object @@ -186794,7 +187456,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *686 + repository: *690 review: description: The review that was affected. type: object @@ -187045,9 +187707,9 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: title: Simple Pull Request type: object @@ -189161,8 +189823,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *686 - review: &733 + repository: *690 + review: &737 description: The review that was affected. type: object properties: @@ -189400,12 +190062,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: description: The pull request number. type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -191752,7 +192414,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 requested_reviewer: title: User type: @@ -191838,12 +192500,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: description: The pull request number. type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -194197,7 +194859,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194392,12 +195054,12 @@ webhooks: type: string enum: - review_requested - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: description: The pull request number. type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -196746,7 +197408,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 requested_reviewer: title: User type: @@ -196833,12 +197495,12 @@ webhooks: type: string enum: - review_requested - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: description: The pull request number. type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -199178,7 +199840,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199362,9 +200024,9 @@ webhooks: type: string enum: - submitted - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: title: Simple Pull Request type: object @@ -201600,8 +202262,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *686 - review: *733 + repository: *690 + review: *737 sender: *4 required: - action @@ -201681,9 +202343,9 @@ webhooks: type: string enum: - resolved - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: title: Simple Pull Request type: object @@ -203814,7 +204476,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *686 + repository: *690 sender: *4 thread: type: object @@ -204211,9 +204873,9 @@ webhooks: type: string enum: - unresolved - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: title: Simple Pull Request type: object @@ -206327,7 +206989,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *686 + repository: *690 sender: *4 thread: type: object @@ -206726,10 +207388,10 @@ webhooks: type: string before: type: string - enterprise: *683 - installation: *684 - number: *728 - organization: *685 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -209064,7 +209726,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -209146,11 +209808,11 @@ webhooks: type: string enum: - unassigned - assignee: *734 - enterprise: *683 - installation: *684 - number: *728 - organization: *685 + assignee: *738 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -211500,7 +212162,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -211579,11 +212241,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *683 - installation: *684 - label: *702 - number: *728 - organization: *685 + enterprise: *687 + installation: *688 + label: *706 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -213922,7 +214584,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -214003,10 +214665,10 @@ webhooks: type: string enum: - unlocked - enterprise: *683 - installation: *684 - number: *728 - organization: *685 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -216335,7 +216997,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -216538,7 +217200,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *683 + enterprise: *687 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -216633,8 +217295,8 @@ webhooks: - url - author - committer - installation: *684 - organization: *685 + installation: *688 + organization: *689 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -217222,9 +217884,9 @@ webhooks: type: string enum: - published - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 registry_package: type: object properties: @@ -217701,7 +218363,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *717 + items: *721 summary: type: string tag_name: @@ -217757,7 +218419,7 @@ webhooks: - owner - package_version - registry - repository: *686 + repository: *690 sender: *4 required: - action @@ -217835,9 +218497,9 @@ webhooks: type: string enum: - updated - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 registry_package: type: object properties: @@ -218149,7 +218811,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *717 + items: *721 summary: type: string tag_name: @@ -218199,7 +218861,7 @@ webhooks: - owner - package_version - registry - repository: *686 + repository: *690 sender: *4 required: - action @@ -218276,10 +218938,10 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - release: &735 + enterprise: *687 + installation: *688 + organization: *689 + release: &739 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -218610,7 +219272,7 @@ webhooks: - updated_at - zipball_url - body - repository: *686 + repository: *690 sender: *4 required: - action @@ -218687,11 +219349,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - release: *735 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + release: *739 + repository: *690 sender: *4 required: - action @@ -218808,11 +219470,11 @@ webhooks: type: boolean required: - to - enterprise: *683 - installation: *684 - organization: *685 - release: *735 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + release: *739 + repository: *690 sender: *4 required: - action @@ -218890,9 +219552,9 @@ webhooks: type: string enum: - prereleased - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -219228,7 +219890,7 @@ webhooks: - string - 'null' format: uri - repository: *686 + repository: *690 sender: *4 required: - action @@ -219304,10 +219966,10 @@ webhooks: type: string enum: - published - enterprise: *683 - installation: *684 - organization: *685 - release: &736 + enterprise: *687 + installation: *688 + organization: *689 + release: &740 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219640,7 +220302,7 @@ webhooks: - string - 'null' format: uri - repository: *686 + repository: *690 sender: *4 required: - action @@ -219716,11 +220378,11 @@ webhooks: type: string enum: - released - enterprise: *683 - installation: *684 - organization: *685 - release: *735 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + release: *739 + repository: *690 sender: *4 required: - action @@ -219796,11 +220458,11 @@ webhooks: type: string enum: - unpublished - enterprise: *683 - installation: *684 - organization: *685 - release: *736 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + release: *740 + repository: *690 sender: *4 required: - action @@ -219876,11 +220538,11 @@ webhooks: type: string enum: - published - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - repository_advisory: *603 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + repository_advisory: *608 sender: *4 required: - action @@ -219956,11 +220618,11 @@ webhooks: type: string enum: - reported - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - repository_advisory: *603 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + repository_advisory: *608 sender: *4 required: - action @@ -220036,10 +220698,10 @@ webhooks: type: string enum: - archived - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220116,10 +220778,10 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220197,10 +220859,10 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220285,10 +220947,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220403,10 +221065,10 @@ webhooks: - 'null' items: type: string - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220478,10 +221140,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 status: type: string @@ -220562,10 +221224,10 @@ webhooks: type: string enum: - privatized - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220642,10 +221304,10 @@ webhooks: type: string enum: - publicized - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220739,10 +221401,10 @@ webhooks: - name required: - repository - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220822,11 +221484,11 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - repository_ruleset: *276 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + repository_ruleset: *281 sender: *4 required: - action @@ -220904,11 +221566,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - repository_ruleset: *276 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + repository_ruleset: *281 sender: *4 required: - action @@ -220986,11 +221648,11 @@ webhooks: type: string enum: - edited - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - repository_ruleset: *276 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + repository_ruleset: *281 changes: type: object properties: @@ -221009,16 +221671,16 @@ webhooks: properties: added: type: array - items: *251 + items: *256 deleted: type: array - items: *251 + items: *256 updated: type: array items: type: object properties: - condition: *251 + condition: *256 changes: type: object properties: @@ -221051,16 +221713,16 @@ webhooks: properties: added: type: array - items: *568 + items: *565 deleted: type: array - items: *568 + items: *565 updated: type: array items: type: object properties: - rule: *568 + rule: *565 changes: type: object properties: @@ -221297,10 +221959,10 @@ webhooks: - from required: - owner - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -221378,10 +222040,10 @@ webhooks: type: string enum: - unarchived - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -221459,7 +222121,7 @@ webhooks: type: string enum: - create - alert: &737 + alert: &741 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -221583,10 +222245,10 @@ webhooks: type: string enum: - open - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -221796,10 +222458,10 @@ webhooks: type: string enum: - dismissed - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -221877,11 +222539,11 @@ webhooks: type: string enum: - reopen - alert: *737 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + alert: *741 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222083,10 +222745,10 @@ webhooks: enum: - fixed - open - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222164,17 +222826,17 @@ webhooks: type: string enum: - created - alert: &738 + alert: &742 type: object properties: - number: *52 - created_at: *53 + number: *151 + created_at: *152 updated_at: anyOf: - type: 'null' - - *54 - url: *55 - html_url: *56 + - *153 + url: *154 + html_url: *155 locations_url: type: string format: uri @@ -222278,10 +222940,10 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222362,11 +223024,11 @@ webhooks: type: string enum: - created - alert: *738 - installation: *684 - location: *739 - organization: *685 - repository: *686 + alert: *742 + installation: *688 + location: *743 + organization: *689 + repository: *690 sender: *4 required: - location @@ -222604,11 +223266,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *738 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + alert: *742 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222686,11 +223348,11 @@ webhooks: type: string enum: - reopened - alert: *738 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + alert: *742 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222768,11 +223430,11 @@ webhooks: type: string enum: - resolved - alert: *738 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + alert: *742 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222850,11 +223512,11 @@ webhooks: type: string enum: - validated - alert: *738 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + alert: *742 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222984,10 +223646,10 @@ webhooks: - organization - enterprise - - repository: *686 - enterprise: *683 - installation: *684 - organization: *685 + repository: *690 + enterprise: *687 + installation: *688 + organization: *689 sender: *4 required: - action @@ -223065,11 +223727,11 @@ webhooks: type: string enum: - published - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - security_advisory: &740 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + security_advisory: &744 description: The details of the security advisory, including summary, description, and severity. type: object @@ -223255,11 +223917,11 @@ webhooks: type: string enum: - updated - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - security_advisory: *740 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + security_advisory: *744 sender: *4 required: - action @@ -223332,10 +223994,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -223521,11 +224183,11 @@ webhooks: from: type: object properties: - security_and_analysis: *250 - enterprise: *683 - installation: *684 - organization: *685 - repository: *322 + security_and_analysis: *255 + enterprise: *687 + installation: *688 + organization: *689 + repository: *317 sender: *4 required: - changes @@ -223603,12 +224265,12 @@ webhooks: type: string enum: - cancelled - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: &741 + sponsorship: &745 type: object properties: created_at: @@ -223913,12 +224575,12 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: *741 + sponsorship: *745 required: - action - sponsorship @@ -224006,12 +224668,12 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: *741 + sponsorship: *745 required: - action - changes @@ -224088,17 +224750,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &742 + effective_date: &746 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: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: *741 + sponsorship: *745 required: - action - sponsorship @@ -224172,7 +224834,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &743 + changes: &747 type: object properties: tier: @@ -224216,13 +224878,13 @@ webhooks: - from required: - tier - effective_date: *742 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + effective_date: *746 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: *741 + sponsorship: *745 required: - action - changes @@ -224299,13 +224961,13 @@ webhooks: type: string enum: - tier_changed - changes: *743 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + changes: *747 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: *741 + sponsorship: *745 required: - action - changes @@ -224379,10 +225041,10 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224466,10 +225128,10 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224903,15 +225565,15 @@ webhooks: type: - string - 'null' - enterprise: *683 + enterprise: *687 id: description: The unique identifier of the status. type: integer - installation: *684 + installation: *688 name: type: string - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 sha: description: The Commit SHA. @@ -225021,15 +225683,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *68 - parent_issue_repo: *66 + parent_issue: *66 + parent_issue_repo: *64 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *68 - installation: *684 - organization: *685 - repository: *686 + sub_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -225113,15 +225775,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *68 - parent_issue_repo: *66 + parent_issue: *66 + parent_issue_repo: *64 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *68 - installation: *684 - organization: *685 - repository: *686 + sub_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -225205,15 +225867,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *68 - sub_issue_repo: *66 + sub_issue: *66 + sub_issue_repo: *64 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *68 - installation: *684 - organization: *685 - repository: *686 + parent_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -225297,15 +225959,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *68 - sub_issue_repo: *66 + sub_issue: *66 + sub_issue_repo: *64 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *68 - installation: *684 - organization: *685 - repository: *686 + parent_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -225382,12 +226044,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - team: &744 + team: &748 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -225617,9 +226279,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 repository: title: Repository description: A git repository @@ -226089,7 +226751,7 @@ webhooks: - topics - visibility sender: *4 - team: *744 + team: *748 required: - action - team @@ -226165,9 +226827,9 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 repository: title: Repository description: A git repository @@ -226637,7 +227299,7 @@ webhooks: - topics - visibility sender: *4 - team: *744 + team: *748 required: - action - team @@ -226714,9 +227376,9 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 repository: title: Repository description: A git repository @@ -227186,7 +227848,7 @@ webhooks: - topics - visibility sender: *4 - team: *744 + team: *748 required: - action - team @@ -227330,9 +227992,9 @@ webhooks: - from required: - permissions - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 repository: title: Repository description: A git repository @@ -227802,7 +228464,7 @@ webhooks: - topics - visibility sender: *4 - team: *744 + team: *748 required: - action - changes @@ -227880,9 +228542,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 repository: title: Repository description: A git repository @@ -228352,7 +229014,7 @@ webhooks: - topics - visibility sender: *4 - team: *744 + team: *748 required: - action - team @@ -228428,10 +229090,10 @@ webhooks: type: string enum: - started - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -228504,17 +229166,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *683 + enterprise: *687 inputs: type: - object - 'null' additionalProperties: true - installation: *684 - organization: *685 + installation: *688 + organization: *689 ref: type: string - repository: *686 + repository: *690 sender: *4 workflow: type: string @@ -228596,10 +229258,10 @@ webhooks: type: string enum: - completed - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 workflow_job: allOf: @@ -228855,7 +229517,7 @@ webhooks: type: string required: - conclusion - deployment: *467 + deployment: *462 required: - action - repository @@ -228934,10 +229596,10 @@ webhooks: type: string enum: - in_progress - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 workflow_job: allOf: @@ -229219,7 +229881,7 @@ webhooks: required: - status - steps - deployment: *467 + deployment: *462 required: - action - repository @@ -229298,10 +229960,10 @@ webhooks: type: string enum: - queued - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 workflow_job: type: object @@ -229447,7 +230109,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *467 + deployment: *462 required: - action - repository @@ -229526,10 +230188,10 @@ webhooks: type: string enum: - waiting - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 workflow_job: type: object @@ -229676,7 +230338,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *467 + deployment: *462 required: - action - repository @@ -229756,12 +230418,12 @@ webhooks: type: string enum: - completed - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - workflow: *698 + workflow: *702 workflow_run: title: Workflow Run type: object @@ -230780,12 +231442,12 @@ webhooks: type: string enum: - in_progress - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - workflow: *698 + workflow: *702 workflow_run: title: Workflow Run type: object @@ -231789,12 +232451,12 @@ webhooks: type: string enum: - requested - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - workflow: *698 + workflow: *702 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 4fd58eb26..2a440794f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -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." @@ -5607,6 +5611,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.", @@ -5804,6 +5816,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": { @@ -6698,6 +6719,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.", @@ -6895,6 +6924,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": { @@ -7562,6 +7600,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.", @@ -7759,6 +7805,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": { @@ -7991,6 +8046,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.", @@ -8188,6 +8251,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": { @@ -10278,6 +10350,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.", @@ -10475,6 +10555,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": { @@ -11401,6 +11490,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.", @@ -11598,6 +11695,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": { @@ -12388,6 +12494,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.", @@ -12585,6 +12699,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": { @@ -13078,6 +13201,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.", @@ -13275,6 +13406,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": { @@ -22616,29 +22756,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).\"", @@ -24471,2163 +24588,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": { - "anyOf": [ - { - "type": "null" - }, - { - "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": { - "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", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "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" - ] - } - ] - }, - "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", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "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", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "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", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "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" - ] - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "push_protection_bypass_request_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "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" - ] - } - ] - }, - "push_protection_bypass_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when reviewing a push protection bypass." - }, - "push_protection_bypass_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when requesting a push protection bypass." - }, - "push_protection_bypass_request_html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment that was optionally added when this alert was closed" - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the secret was publicly leaked." - }, - "multi_repo": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." - }, - "is_base64_encoded": { - "type": [ - "boolean", - "null" - ], - "description": "A boolean value representing whether or not alert is base64 encoded" - }, - "first_location_detected": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - "/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", - "examples": [ - "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", - "examples": [ - "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", - "examples": [ - "/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", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "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.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - ] - }, - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "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" - ] - } - ] - } - } - } - }, - "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", @@ -26874,6 +24834,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": { "type": [ "string", @@ -28424,6 +26394,876 @@ } } }, + "/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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", @@ -28670,6 +27510,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": { "type": [ "string", @@ -76361,10 +75211,391 @@ } } }, + "/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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" ], @@ -76508,7 +75739,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -76516,7 +75747,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -76524,7 +75755,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -79074,6 +78305,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -79204,6 +78442,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -79344,6 +78586,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -79362,6 +78611,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": [ @@ -79459,6 +78713,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -79589,6 +78850,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -79644,6 +78909,639 @@ } } }, + "/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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", @@ -80238,6 +80136,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -80368,6 +80273,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -80483,6 +80392,13 @@ "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", + "null" + ] } } }, @@ -80569,6 +80485,309 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "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", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "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, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + 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", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + }, + "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", + "examples": [ + 5 + ] + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 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", + "examples": [ + "latest" + ] } }, "required": [ @@ -80699,291 +80918,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] - } - }, - "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", - "examples": [ - 5 - ] }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "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", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "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, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "image_gen": { "type": "boolean", - "examples": [ - 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", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -86971,6 +86909,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -87101,6 +87046,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -97158,6 +97107,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", @@ -98836,7 +98889,10 @@ }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", - "type": "array", + "type": [ + "array", + "null" + ], "minItems": 1, "items": { "type": "object", @@ -98870,8 +98926,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -115170,29 +115237,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).\"", @@ -135763,6 +135807,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.", @@ -135960,6 +136012,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": { @@ -136869,6 +136930,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.", @@ -137066,6 +137135,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": { @@ -171836,17 +171914,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } }, @@ -180822,17 +180904,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -353327,16 +353413,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).\"", @@ -353364,29 +353440,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": { @@ -395615,6 +395668,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.", @@ -395812,6 +395873,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": { @@ -577049,7 +577119,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" ], @@ -658103,6 +658173,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.", @@ -658300,6 +658378,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": { @@ -731001,6 +731088,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.", @@ -731198,6 +731293,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": { @@ -739040,17 +739144,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -747999,17 +748107,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -776666,7 +776778,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" ], @@ -776797,7 +776909,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -776805,7 +776917,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -776813,7 +776925,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -946024,6 +946136,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.", @@ -946221,6 +946341,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": { @@ -949090,6 +949219,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.", @@ -949287,6 +949424,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": { @@ -952061,6 +952207,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.", @@ -952258,6 +952412,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": { @@ -955032,6 +955195,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.", @@ -955229,6 +955400,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": { @@ -958137,6 +958317,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.", @@ -958334,6 +958522,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": { @@ -961249,6 +961446,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.", @@ -961446,6 +961651,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": { @@ -966356,6 +966570,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.", @@ -966553,6 +966775,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-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 0aad05175..f1d93bcbd 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -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 @@ -905,7 +907,7 @@ paths: - subscriptions_url - type - url - type: &292 + type: &287 type: string description: The type of credit the user is receiving. enum: @@ -1038,7 +1040,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &106 + schema: &105 title: Validation Error Simple description: Validation Error Simple type: object @@ -1071,7 +1073,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &605 + - &610 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1656,7 +1658,7 @@ paths: schema: type: integer default: 30 - - &177 + - &183 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 @@ -1672,7 +1674,7 @@ paths: application/json: schema: type: array - items: &178 + items: &184 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1768,7 +1770,7 @@ paths: - installation_id - repository_id examples: - default: &179 + default: &185 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1831,7 +1833,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &105 + schema: &104 title: Validation Error description: Validation Error type: object @@ -1903,7 +1905,7 @@ paths: description: Response content: application/json: - schema: &180 + schema: &186 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2038,7 +2040,7 @@ paths: - request - response examples: - default: &181 + default: &187 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2242,7 +2244,7 @@ paths: parameters: - *17 - *19 - - &75 + - &72 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) @@ -2495,6 +2497,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 @@ -2675,6 +2685,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 @@ -2792,7 +2811,7 @@ paths: suspended_at: suspended_by: headers: - Link: &57 + Link: &52 example: ; rel="next", ; rel="last" schema: @@ -2982,7 +3001,7 @@ paths: - selected repositories: type: array - items: &66 + items: &64 title: Repository description: A repository on GitHub. type: object @@ -3009,7 +3028,7 @@ paths: license: anyOf: - type: 'null' - - &71 + - &69 title: License Simple description: License Simple type: object @@ -5387,7 +5406,7 @@ paths: responses: '202': *37 '422': *7 - '500': &100 + '500': &98 description: Internal Error content: application/json: @@ -7717,7 +7736,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &152 + code_scanning_options: &161 type: - object - 'null' @@ -7915,7 +7934,7 @@ paths: description: Response content: application/json: - schema: &154 + schema: &163 type: array description: A list of default code security configurations items: @@ -7931,7 +7950,7 @@ paths: default configuration: *41 examples: - default: &155 + default: &164 value: - default_for_new_repos: public configuration: @@ -8262,7 +8281,7 @@ paths: - *40 - *43 responses: - '204': &156 + '204': &165 description: A header with no content is returned. '400': *14 '403': *27 @@ -8389,7 +8408,7 @@ paths: default: value: default_for_new_repos: all - configuration: &153 + configuration: &162 value: id: 1325 target_type: organization @@ -8474,7 +8493,7 @@ paths: application/json: schema: type: array - items: &157 + items: &166 type: object description: Repositories associated with a code security configuration and attachment status @@ -8819,7 +8838,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &158 + repository: &167 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8913,7 +8932,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &162 + - &170 name: state in: query description: |- @@ -8922,7 +8941,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &163 + - &171 name: severity in: query description: |- @@ -8931,7 +8950,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &164 + - &172 name: ecosystem in: query description: |- @@ -8940,14 +8959,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &165 + - &173 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 - - &166 + - &174 name: epss_percentage in: query description: |- @@ -8959,7 +8978,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 - - &458 + - &453 name: has in: query description: |- @@ -8973,7 +8992,7 @@ paths: type: string enum: - patch - - &167 + - &175 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8983,7 +9002,7 @@ paths: enum: - development - runtime - - &168 + - &176 name: sort in: query description: |- @@ -9001,31 +9020,6 @@ paths: - *46 - *38 - *39 - - &169 - 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 - - &170 - 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': @@ -9034,11 +9028,11 @@ paths: application/json: schema: type: array - items: &171 + items: &177 type: object description: A Dependabot alert. properties: - number: &52 + number: &151 type: integer description: The security alert number. readOnly: true @@ -9104,7 +9098,7 @@ paths: - direct - transitive - - security_advisory: &459 + security_advisory: &454 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9311,29 +9305,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *50 - url: &55 + url: &154 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &56 + html_url: &155 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &53 + created_at: &152 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: &54 + updated_at: &153 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: &148 + dismissed_at: &157 type: - string - 'null' @@ -9364,7 +9358,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &147 + fixed_at: &156 type: - string - 'null' @@ -9372,7 +9366,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &460 + auto_dismissed_at: &455 type: - string - 'null' @@ -9399,7 +9393,7 @@ paths: - repository additionalProperties: false examples: - default: &172 + default: &178 value: - number: 2 state: dismissed @@ -9727,740 +9721,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: - - *40 - - &280 - 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 - - &281 - 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 - - &282 - 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 - - &283 - 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 - - *46 - - *17 - - *38 - - *39 - - &284 - 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 - - &285 - 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 - - &286 - 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 - - &287 - 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: &288 - type: object - properties: - number: *52 - created_at: *53 - updated_at: - anyOf: - - type: 'null' - - *54 - url: *55 - html_url: *56 - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this - alert. - state: &583 - 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: &584 - type: - - string - - 'null' - description: "**Required when the `state` is `resolved`.** The - reason for resolving the alert." - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - - - resolved_at: - type: - - string - - 'null' - format: date-time - description: 'The time that the alert was resolved in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - resolved_by: - anyOf: - - type: 'null' - - *4 - 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: *51 - push_protection_bypassed: - type: - - boolean - - 'null' - description: Whether push protection was bypassed for the detected - secret. - push_protection_bypassed_by: - anyOf: - - type: 'null' - - *4 - push_protection_bypassed_at: - type: - - string - - 'null' - format: date-time - description: 'The time that push protection was bypassed in - ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - push_protection_bypass_request_reviewer: - anyOf: - - type: 'null' - - *4 - push_protection_bypass_request_reviewer_comment: - type: - - string - - 'null' - description: An optional comment when reviewing a push protection - bypass. - push_protection_bypass_request_comment: - type: - - string - - 'null' - description: An optional comment when requesting a push protection - bypass. - push_protection_bypass_request_html_url: - type: - - string - - 'null' - format: uri - description: The URL to a push protection bypass request. - resolution_comment: - type: - - string - - 'null' - description: The comment that was optionally added when this - alert was closed - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: - - boolean - - 'null' - description: Whether the secret was publicly leaked. - multi_repo: - type: - - boolean - - 'null' - description: Whether the detected secret was found in multiple - repositories in the same organization or enterprise. - is_base64_encoded: - type: - - boolean - - 'null' - description: A boolean value representing whether or not alert - is base64 encoded - first_location_detected: - anyOf: - - type: 'null' - - &585 - description: 'Details on the location where the token was - initially detected. This can be a commit, wiki commit, issue, - discussion, pull request. - - ' - oneOf: - - &587 - 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 - examples: - - "/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 - examples: - - 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 - examples: - - 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 - - &588 - 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 - examples: - - "/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 - examples: - - af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki - page - examples: - - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - examples: - - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki - commit - examples: - - 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 - - &589 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - - &590 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - - &591 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - - &592 - 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. - examples: - - https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - - &593 - 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. - examples: - - https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - - &594 - 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. - examples: - - https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - - &595 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - - &596 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - - &597 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - - &598 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - - &599 - 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. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url - 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: - anyOf: - - type: 'null' - - *4 - examples: - default: &289 - 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: *57 - '404': *6 - '503': &73 - 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 @@ -10482,7 +9742,7 @@ paths: application/json: schema: type: array - items: &58 + items: &53 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -10547,7 +9807,7 @@ paths: - updated_at - group_id examples: - default: &59 + default: &54 value: - id: 1 name: Justice League @@ -10560,7 +9820,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *57 + Link: *52 '403': *27 x-github: githubCloudOnly: false @@ -10604,6 +9864,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: type: - string @@ -10623,9 +9895,9 @@ paths: description: Response content: application/json: - schema: *58 + schema: *53 examples: - default: *59 + default: *54 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10643,7 +9915,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *40 - - &60 + - &55 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -10662,7 +9934,7 @@ paths: type: array items: *4 examples: - default: &61 + default: &56 value: - login: octocat id: 1 @@ -10683,7 +9955,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10701,7 +9973,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *40 - - *60 + - *55 requestBody: required: true content: @@ -10732,7 +10004,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10750,7 +10022,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *40 - - *60 + - *55 requestBody: required: true content: @@ -10781,7 +10053,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10799,8 +10071,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *40 - - *60 - - &62 + - *55 + - &57 name: username description: The handle for the GitHub user account. in: path @@ -10814,7 +10086,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &63 + exampleKey1: &58 value: login: octocat id: 1 @@ -10850,8 +10122,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *40 - - *60 - - *62 + - *55 + - *57 responses: '201': description: Successfully added team member @@ -10859,7 +10131,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *63 + exampleKey1: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10877,8 +10149,8 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *40 - - *60 - - *62 + - *55 + - *57 responses: '204': description: Response @@ -10888,6 +10160,303 @@ 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: + - *40 + - *55 + - *17 + - *19 + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: &59 + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + examples: + default: &60 + 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: + - *40 + - *55 + 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: *59 + examples: + default: &96 + 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: + - *40 + - *55 + 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: + - *40 + - *55 + - &61 + 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: *59 + examples: + default: *60 + '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: + - *40 + - *55 + - *61 + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: *59 + examples: + default: *60 + 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: + - *40 + - *55 + - *61 + 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 @@ -10903,7 +10472,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *40 - - &64 + - &62 name: team_slug description: The slug of the team name. in: path @@ -10915,11 +10484,11 @@ paths: description: Response content: application/json: - schema: *58 + schema: *53 examples: - default: *59 + default: *54 headers: - Link: *57 + Link: *52 '403': *27 x-github: githubCloudOnly: false @@ -10937,7 +10506,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *40 - - *64 + - *62 requestBody: required: true content: @@ -10965,6 +10534,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: type: - string @@ -10983,11 +10564,11 @@ paths: description: Response content: application/json: - schema: *58 + schema: *53 examples: - default: *59 + default: *54 headers: - Link: *57 + Link: *52 '403': *27 x-github: githubCloudOnly: false @@ -11008,7 +10589,7 @@ paths: url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *40 - - *64 + - *62 responses: '204': description: Response @@ -11046,7 +10627,7 @@ paths: application/json: schema: type: array - items: &94 + items: &91 title: Event description: Event type: object @@ -11057,7 +10638,7 @@ paths: type: - string - 'null' - actor: &65 + actor: &63 title: Actor description: Actor type: object @@ -11098,7 +10679,7 @@ paths: - id - name - url - org: *65 + org: *63 payload: oneOf: - title: CreateEvent @@ -11145,7 +10726,7 @@ paths: properties: action: type: string - discussion: &699 + discussion: &703 title: Discussion description: A Discussion in a repository. type: object @@ -11442,7 +11023,7 @@ paths: - id labels: type: array - items: &67 + items: &65 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -11525,7 +11106,7 @@ paths: properties: action: type: string - issue: &68 + issue: &66 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -11648,7 +11229,7 @@ paths: milestone: anyOf: - type: 'null' - - &238 + - &244 title: Milestone description: A collection of related issues and pull requests. @@ -11820,7 +11401,7 @@ paths: timeline_url: type: string format: uri - type: &199 + type: &205 title: Issue Type description: The type of issue. type: @@ -11874,12 +11455,12 @@ paths: - node_id - name - description - repository: *66 + repository: *64 performed_via_github_app: anyOf: - type: 'null' - *5 - author_association: &69 + author_association: &67 title: author_association type: string description: How the author is associated with the @@ -11895,7 +11476,7 @@ paths: - OWNER examples: - OWNER - reactions: &70 + reactions: &68 title: Reaction Rollup type: object properties: @@ -11931,7 +11512,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &617 + sub_issues_summary: &622 title: Sub-issues Summary type: object properties: @@ -11952,7 +11533,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &618 + issue_dependencies_summary: &623 title: Issue Dependencies Summary type: object properties: @@ -11971,7 +11552,7 @@ paths: - total_blocking issue_field_values: type: array - items: &619 + items: &624 title: Issue Field Value description: A value assigned to an issue field type: object @@ -12071,10 +11652,10 @@ paths: assignees: type: array items: *4 - label: *67 + label: *65 labels: type: array - items: *67 + items: *65 required: - action - issue @@ -12083,8 +11664,8 @@ paths: properties: action: type: string - issue: *68 - comment: &506 + issue: *66 + comment: &501 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -12134,12 +11715,12 @@ paths: issue_url: type: string format: uri - author_association: *69 + author_association: *67 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *70 + reactions: *68 required: - id - node_id @@ -12318,7 +11899,7 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 allow_forking: type: boolean is_template: @@ -12409,7 +11990,7 @@ paths: type: string number: type: integer - pull_request: &72 + pull_request: &70 title: Pull Request Minimal type: object properties: @@ -12480,10 +12061,10 @@ paths: assignees: type: array items: *4 - label: *67 + label: *65 labels: type: array - items: *67 + items: *65 required: - action - number @@ -12493,7 +12074,7 @@ paths: properties: action: type: string - pull_request: *72 + pull_request: *70 comment: type: object properties: @@ -12747,7 +12328,7 @@ paths: - pull_request updated_at: type: string - pull_request: *72 + pull_request: *70 required: - action - review @@ -12796,7 +12377,7 @@ paths: updated_at: type: string format: date-time - reactions: *70 + reactions: *68 required: - action - comment @@ -12807,7 +12388,7 @@ paths: type: string release: allOf: - - &558 + - &555 title: Release description: A release. type: object @@ -12889,7 +12470,7 @@ paths: author: *4 assets: type: array - items: &559 + items: &556 title: Release Asset description: Data related to a release. type: object @@ -12964,7 +12545,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *70 + reactions: *68 required: - assets_url - upload_url @@ -13057,7 +12638,19 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': *73 + '503': &99 + 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 @@ -13147,7 +12740,7 @@ paths: _links: type: object properties: - timeline: &74 + timeline: &71 title: Link With Type description: Hypermedia Link with Type type: object @@ -13159,17 +12752,17 @@ paths: required: - href - type - user: *74 - security_advisories: *74 - current_user: *74 - current_user_public: *74 - current_user_actor: *74 - current_user_organization: *74 + user: *71 + security_advisories: *71 + current_user: *71 + current_user_public: *71 + current_user_actor: *71 + current_user_organization: *71 current_user_organizations: type: array - items: *74 - repository_discussions: *74 - repository_discussions_category: *74 + items: *71 + repository_discussions: *71 + repository_discussions_category: *71 required: - timeline - user @@ -13231,7 +12824,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *75 + - *72 - *17 - *19 responses: @@ -13241,7 +12834,7 @@ paths: application/json: schema: type: array - items: &76 + items: &73 title: Base Gist description: Base Gist type: object @@ -13338,7 +12931,7 @@ paths: - created_at - updated_at examples: - default: &77 + default: &74 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -13383,7 +12976,7 @@ paths: site_admin: false truncated: false headers: - Link: *57 + Link: *52 '304': *35 '403': *27 x-github: @@ -13462,7 +13055,7 @@ paths: description: Response content: application/json: - schema: &78 + schema: &75 title: Gist Simple description: Gist Simple type: object @@ -13480,7 +13073,7 @@ paths: url: type: string format: uri - user: &631 + user: &636 title: Public User description: Public User type: object @@ -13854,7 +13447,7 @@ paths: truncated: type: boolean examples: - default: &79 + default: &76 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -13958,7 +13551,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *75 + - *72 - *17 - *19 responses: @@ -13968,11 +13561,11 @@ paths: application/json: schema: type: array - items: *76 + items: *73 examples: - default: *77 + default: *74 headers: - Link: *57 + Link: *52 '422': *15 '304': *35 '403': *27 @@ -13992,7 +13585,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *75 + - *72 - *17 - *19 responses: @@ -14002,11 +13595,11 @@ paths: application/json: schema: type: array - items: *76 + items: *73 examples: - default: *77 + default: *74 headers: - Link: *57 + Link: *52 '401': *23 '304': *35 '403': *27 @@ -14032,7 +13625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &80 + - &77 name: gist_id description: The unique identifier of the gist. in: path @@ -14044,10 +13637,10 @@ paths: description: Response content: application/json: - schema: *78 + schema: *75 examples: - default: *79 - '403': &83 + default: *76 + '403': &80 description: Forbidden Gist content: application/json: @@ -14096,7 +13689,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *80 + - *77 requestBody: required: true content: @@ -14160,9 +13753,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *75 examples: - updateGist: *79 + updateGist: *76 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -14320,7 +13913,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *80 + - *77 responses: '204': description: Response @@ -14349,7 +13942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *80 + - *77 - *17 - *19 responses: @@ -14359,7 +13952,7 @@ paths: application/json: schema: type: array - items: &81 + items: &78 title: Gist Comment description: A comment made to a gist. type: object @@ -14397,7 +13990,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *69 + author_association: *67 required: - url - id @@ -14437,7 +14030,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -14462,7 +14055,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *80 + - *77 requestBody: required: true content: @@ -14488,9 +14081,9 @@ paths: description: Response content: application/json: - schema: *81 + schema: *78 examples: - default: &82 + default: &79 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -14548,8 +14141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *80 - - &84 + - *77 + - &81 name: comment_id description: The unique identifier of the comment. in: path @@ -14562,12 +14155,12 @@ paths: description: Response content: application/json: - schema: *81 + schema: *78 examples: - default: *82 + default: *79 '304': *35 '404': *6 - '403': *83 + '403': *80 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14589,8 +14182,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *80 - - *84 + - *77 + - *81 requestBody: required: true content: @@ -14616,9 +14209,9 @@ paths: description: Response content: application/json: - schema: *81 + schema: *78 examples: - default: *82 + default: *79 '404': *6 x-github: githubCloudOnly: false @@ -14635,8 +14228,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *80 - - *84 + - *77 + - *81 responses: '204': description: Response @@ -14659,7 +14252,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *80 + - *77 - *17 - *19 responses: @@ -14760,7 +14353,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *80 + - *77 - *17 - *19 responses: @@ -14770,7 +14363,7 @@ paths: application/json: schema: type: array - items: *78 + items: *75 examples: default: value: @@ -14816,7 +14409,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 '404': *6 '304': *35 '403': *27 @@ -14835,13 +14428,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *80 + - *77 responses: '201': description: Response content: application/json: - schema: *76 + schema: *73 examples: default: value: @@ -14912,7 +14505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *80 + - *77 responses: '204': description: Response if gist is starred @@ -14942,7 +14535,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *80 + - *77 responses: '204': description: Response @@ -14964,7 +14557,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *80 + - *77 responses: '204': description: Response @@ -14993,7 +14586,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *80 + - *77 - name: sha in: path required: true @@ -15004,9 +14597,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *75 examples: - default: *79 + default: *76 '422': *15 '404': *6 '403': *27 @@ -15167,7 +14760,7 @@ paths: type: integer repositories: type: array - items: *66 + items: *64 repository_selection: type: string examples: @@ -15291,7 +14884,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *57 + Link: *52 '403': *27 '304': *35 '401': *23 @@ -15375,7 +14968,7 @@ paths: - closed - all default: open - - &202 + - &208 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -15394,7 +14987,7 @@ paths: - comments default: created - *46 - - *75 + - *72 - name: collab in: query required: false @@ -15424,9 +15017,9 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: &203 + default: &209 value: - id: 1 node_id: MDU6SXNzdWUx @@ -15671,7 +15264,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *57 + Link: *52 '422': *15 '304': *35 '404': *6 @@ -15706,7 +15299,7 @@ paths: application/json: schema: type: array - items: *71 + items: *69 examples: default: value: @@ -16004,7 +15597,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &85 + X-CommonMarker-Version: &82 example: 0.17.4 schema: type: string @@ -16059,7 +15652,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *85 + X-CommonMarker-Version: *82 content: text/html: schema: @@ -16088,7 +15681,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &88 + - &85 name: account_id description: account_id parameter in: path @@ -16100,7 +15693,7 @@ paths: description: Response content: application/json: - schema: &87 + schema: &84 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -16134,7 +15727,7 @@ paths: - 'null' id: type: integer - plan: &86 + plan: &83 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -16237,7 +15830,7 @@ paths: - 'null' updated_at: type: string - plan: *86 + plan: *83 required: - url - id @@ -16245,7 +15838,7 @@ paths: - login - marketplace_purchase examples: - default: &89 + default: &86 value: url: https://api.github.com/orgs/github type: Organization @@ -16330,9 +15923,9 @@ paths: application/json: schema: type: array - items: *86 + items: *83 examples: - default: &90 + default: &87 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -16350,7 +15943,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *57 + Link: *52 '404': *6 '401': *23 x-github: @@ -16372,14 +15965,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &91 + - &88 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &92 + - &89 name: sort description: The property to sort the results by. in: query @@ -16409,9 +16002,9 @@ paths: application/json: schema: type: array - items: *87 + items: *84 examples: - default: &93 + default: &90 value: - url: https://api.github.com/orgs/github type: Organization @@ -16462,7 +16055,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *57 + Link: *52 '404': *6 '422': *15 '401': *23 @@ -16485,15 +16078,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *88 + - *85 responses: '200': description: Response content: application/json: - schema: *87 + schema: *84 examples: - default: *89 + default: *86 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -16525,11 +16118,11 @@ paths: application/json: schema: type: array - items: *86 + items: *83 examples: - default: *90 + default: *87 headers: - Link: *57 + Link: *52 '401': *23 x-github: githubCloudOnly: false @@ -16550,8 +16143,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *91 - - *92 + - *88 + - *89 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -16571,11 +16164,11 @@ paths: application/json: schema: type: array - items: *87 + items: *84 examples: - default: *93 + default: *90 headers: - Link: *57 + Link: *52 '401': *23 x-github: githubCloudOnly: false @@ -16838,14 +16431,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &314 + - &309 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &315 + - &310 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16862,7 +16455,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -16907,7 +16500,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &323 + '301': &318 description: Moved permanently content: application/json: @@ -16929,7 +16522,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &534 + - &529 name: all description: If `true`, show notifications marked as read. in: query @@ -16937,7 +16530,7 @@ paths: schema: type: boolean default: false - - &535 + - &530 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16946,8 +16539,8 @@ paths: schema: type: boolean default: false - - *75 - - &536 + - *72 + - &531 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: @@ -16972,14 +16565,14 @@ paths: application/json: schema: type: array - items: &95 + items: &92 title: Thread description: Thread type: object properties: id: type: string - repository: &131 + repository: &135 title: Minimal Repository description: Minimal Repository type: object @@ -17318,7 +16911,7 @@ paths: type: boolean examples: - false - security_and_analysis: &250 + security_and_analysis: &255 type: - object - 'null' @@ -17483,7 +17076,7 @@ paths: - url - subscription_url examples: - default: &537 + default: &532 value: - id: '1' repository: @@ -17565,7 +17158,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -17649,7 +17242,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &96 + - &93 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 @@ -17663,7 +17256,7 @@ paths: description: Response content: application/json: - schema: *95 + schema: *92 examples: default: value: @@ -17765,7 +17358,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *96 + - *93 responses: '205': description: Reset Content @@ -17787,7 +17380,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *96 + - *93 responses: '204': description: No content @@ -17810,13 +17403,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *96 + - *93 responses: '200': description: Response content: application/json: - schema: &97 + schema: &94 title: Thread Subscription description: Thread Subscription type: object @@ -17860,7 +17453,7 @@ paths: - url - subscribed examples: - default: &98 + default: &95 value: subscribed: true ignored: false @@ -17891,7 +17484,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *96 + - *93 requestBody: required: false content: @@ -17912,9 +17505,9 @@ paths: description: Response content: application/json: - schema: *97 + schema: *94 examples: - default: *98 + default: *95 '304': *35 '403': *27 '401': *23 @@ -17937,7 +17530,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *96 + - *93 responses: '204': description: Response @@ -18032,92 +17625,9 @@ paths: application/json: schema: type: array - items: &160 - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - examples: - - github - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github - repos_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/events - hooks_url: - type: string - examples: - - https://api.github.com/orgs/github/hooks - issues_url: - type: string - examples: - - https://api.github.com/orgs/github/issues - members_url: - type: string - examples: - - https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - examples: - - https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - examples: - - https://github.com/images/error/octocat_happy.gif - description: - type: - - string - - 'null' - examples: - - A great organization - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description + items: *59 examples: - default: &647 - 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: *96 headers: Link: example: ; rel="next" @@ -18144,13 +17654,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: - - &99 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string + - *61 - name: page in: query description: The page number of results to fetch. @@ -18301,7 +17805,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -18367,7 +17871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *99 + - *61 requestBody: required: true content: @@ -18401,12 +17905,134 @@ 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: + - *61 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &97 + 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 + type: + - 'null' + - string + - array + required: + - property_name + - value + examples: + default: &538 + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + '403': *27 + '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: + - *61 + 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: *97 + required: + - properties + examples: + default: &539 + 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': *27 + '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 @@ -18414,8 +18040,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - - *99 - - &101 + - *61 + - &100 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, @@ -18424,7 +18050,7 @@ paths: required: false schema: type: integer - - &673 + - &677 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 @@ -18433,7 +18059,7 @@ paths: required: false schema: type: integer - - &102 + - &101 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 @@ -18448,14 +18074,14 @@ paths: required: false schema: type: string - - &674 + - &678 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &675 + - &679 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -18517,19 +18143,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 @@ -18571,8 +18197,8 @@ paths: '400': *14 '403': *27 '404': *6 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18592,9 +18218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - *99 - - *101 - - &678 + - *61 + - *100 + - &682 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 @@ -18603,8 +18229,8 @@ paths: required: false schema: type: integer - - *102 - - &679 + - *101 + - &683 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 @@ -18687,8 +18313,8 @@ paths: repositoryName: github/example '400': *14 '403': *27 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18714,13 +18340,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &103 + schema: &102 title: Organization Full description: Organization Full type: object @@ -19115,7 +18741,7 @@ paths: - updated_at - archived_at examples: - default-response: &104 + default-response: &103 value: login: github id: 1 @@ -19215,7 +18841,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *99 + - *61 requestBody: required: false content: @@ -19432,17 +19058,17 @@ paths: description: Response content: application/json: - schema: *103 + schema: *102 examples: - default: *104 + default: *103 '422': description: Validation failed content: application/json: schema: oneOf: + - *104 - *105 - - *106 '409': *45 x-github: githubCloudOnly: false @@ -19466,7 +19092,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *99 + - *61 responses: '202': *37 '404': *6 @@ -19491,7 +19117,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -19517,7 +19143,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19538,7 +19164,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: - - *99 + - *61 - *17 - *19 responses: @@ -19556,7 +19182,7 @@ paths: type: integer repository_cache_usages: type: array - items: &328 + items: &323 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -19594,7 +19220,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19614,7 +19240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *99 + - *61 - *17 - *19 responses: @@ -19632,7 +19258,7 @@ paths: type: integer runners: type: array - items: &107 + items: &106 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -19684,12 +19310,18 @@ paths: - github - partner - custom + version: + description: The image version of the hosted runner + pool. + type: string + examples: + - latest required: - id - size_gb - display_name - source - machine_size_details: &110 + machine_size_details: &114 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -19785,6 +19417,10 @@ paths: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled + for the hosted runners. required: - id - name @@ -19794,7 +19430,7 @@ paths: - public_ip_enabled - platform examples: - default: &130 + default: &134 value: total_count: 2 runners: @@ -19836,7 +19472,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19854,7 +19490,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -19883,6 +19519,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -19900,6 +19542,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 @@ -19921,9 +19568,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *106 examples: - default: &111 + default: &115 value: id: 5 name: My hosted ubuntu runner @@ -19950,6 +19597,320 @@ 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: + - *61 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: &107 + 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 + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with + the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the + image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with + the image. + type: string + examples: + - Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + examples: + default: &109 + 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: + - *61 + - &108 + 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: *107 + 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: + - *61 + - *108 + 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: + - *108 + - *61 + 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: &110 + 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 + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - None + required: + - version + - state + - size_gb + - created_on + - state_details + examples: + default: *109 + 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: + - *61 + - *108 + - &111 + 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: *110 + 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: + - *61 + - *108 + - *111 + 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 @@ -19962,7 +19923,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: - - *99 + - *61 responses: '200': description: Response @@ -19978,7 +19939,7 @@ paths: type: integer images: type: array - items: &108 + items: &112 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -20018,7 +19979,7 @@ paths: - display_name - source examples: - default: &109 + default: &113 value: id: ubuntu-20.04 platform: linux-x64 @@ -20042,7 +20003,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: - - *99 + - *61 responses: '200': description: Response @@ -20058,9 +20019,9 @@ paths: type: integer images: type: array - items: *108 + items: *112 examples: - default: *109 + default: *113 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20077,7 +20038,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: - - *99 + - *61 responses: '200': description: Response @@ -20132,7 +20093,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: - - *99 + - *61 responses: '200': description: Response @@ -20148,7 +20109,7 @@ paths: type: integer machine_specs: type: array - items: *110 + items: *114 examples: default: value: @@ -20173,7 +20134,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: - - *99 + - *61 responses: '200': description: Response @@ -20217,8 +20178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *99 - - &112 + - *61 + - &116 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -20230,11 +20191,11 @@ paths: description: Response content: application/json: - schema: *107 + schema: *106 examples: - default: *111 + default: *115 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20252,8 +20213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *99 - - *112 + - *61 + - *116 requestBody: required: true content: @@ -20279,6 +20240,12 @@ 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 + - 'null' examples: default: value: @@ -20291,9 +20258,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *106 examples: - default: *111 + default: *115 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20309,16 +20276,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *99 - - *112 + - *61 + - *116 responses: '202': description: Response content: application/json: - schema: *107 + schema: *106 examples: - default: *111 + default: *115 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -20338,13 +20305,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: - - *99 + - *61 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &113 + schema: &117 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -20358,7 +20325,7 @@ paths: required: - include_claim_keys examples: - default: &114 + default: &118 value: include_claim_keys: - repo @@ -20380,20 +20347,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: - - *99 + - *61 requestBody: required: true content: application/json: - schema: *113 + schema: *117 examples: - default: *114 + default: *118 responses: '201': description: Empty response content: application/json: - schema: &140 + schema: &144 title: Empty Object description: An object without any properties. type: object @@ -20423,7 +20390,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -20432,7 +20399,7 @@ paths: schema: type: object properties: - enabled_repositories: &115 + enabled_repositories: &119 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -20445,7 +20412,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: &116 + allowed_actions: &120 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -20453,12 +20420,12 @@ paths: - all - local_only - selected - selected_actions_url: &334 + selected_actions_url: &329 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: &117 + sha_pinning_required: &121 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -20489,7 +20456,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Response @@ -20500,9 +20467,9 @@ paths: schema: type: object properties: - enabled_repositories: *115 - allowed_actions: *116 - sha_pinning_required: *117 + enabled_repositories: *119 + allowed_actions: *120 + sha_pinning_required: *121 required: - enabled_repositories examples: @@ -20530,13 +20497,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &338 + schema: &333 type: object properties: days: @@ -20573,12 +20540,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: application/json: - schema: &339 + schema: &334 type: object properties: days: @@ -20615,13 +20582,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &118 + schema: &122 type: object properties: approval_policy: @@ -20635,7 +20602,7 @@ paths: required: - approval_policy examples: - default: &340 + default: &335 value: approval_policy: first_time_contributors '404': *6 @@ -20656,7 +20623,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Response @@ -20666,7 +20633,7 @@ paths: required: true content: application/json: - schema: *118 + schema: *122 examples: default: summary: Set approval policy to first time contributors @@ -20688,13 +20655,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: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &341 + schema: &336 type: object required: - run_workflows_from_fork_pull_requests @@ -20720,7 +20687,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &119 + default: &123 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -20743,12 +20710,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: - - *99 + - *61 requestBody: required: true content: application/json: - schema: &342 + schema: &337 type: object required: - run_workflows_from_fork_pull_requests @@ -20771,7 +20738,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *119 + default: *123 responses: '204': description: Empty response for successful settings update @@ -20801,7 +20768,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: - - *99 + - *61 - *17 - *19 responses: @@ -20819,9 +20786,9 @@ paths: type: number repositories: type: array - items: *66 + items: *64 examples: - default: &123 + default: &127 value: total_count: 1 repositories: @@ -20961,7 +20928,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: - - *99 + - *61 responses: '204': description: Response @@ -21005,8 +20972,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: - - *99 - - &120 + - *61 + - &124 name: repository_id description: The unique identifier of the repository. in: path @@ -21034,8 +21001,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: - - *99 - - *120 + - *61 + - *124 responses: '204': description: Response @@ -21058,13 +21025,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &121 + schema: &125 type: object properties: github_owned_allowed: @@ -21086,7 +21053,7 @@ paths: items: type: string examples: - default: &122 + default: &126 value: github_owned_allowed: true verified_allowed: false @@ -21111,7 +21078,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Response @@ -21119,9 +21086,9 @@ paths: required: false content: application/json: - schema: *121 + schema: *125 examples: - selected_actions: *122 + selected_actions: *126 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21141,7 +21108,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -21189,7 +21156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -21236,7 +21203,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: - - *99 + - *61 - *17 - *19 responses: @@ -21251,9 +21218,9 @@ paths: type: integer repositories: type: array - items: *66 + items: *64 examples: - default: *123 + default: *127 '403': *27 '404': *6 x-github: @@ -21273,7 +21240,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: - - *99 + - *61 requestBody: required: true content: @@ -21321,8 +21288,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: - - *99 - - *120 + - *61 + - *124 responses: '204': description: No content @@ -21348,8 +21315,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: - - *99 - - *120 + - *61 + - *124 responses: '204': description: No content @@ -21377,23 +21344,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &343 + schema: &338 type: object properties: - default_workflow_permissions: &124 + default_workflow_permissions: &128 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &125 + can_approve_pull_request_reviews: &129 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -21401,7 +21368,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &126 + default: &130 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -21426,7 +21393,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Success response @@ -21434,13 +21401,13 @@ paths: required: false content: application/json: - schema: &344 + schema: &339 type: object properties: - default_workflow_permissions: *124 - can_approve_pull_request_reviews: *125 + default_workflow_permissions: *128 + can_approve_pull_request_reviews: *129 examples: - default: *126 + default: *130 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21460,7 +21427,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: - - *99 + - *61 - *17 - *19 - name: visible_to_repository @@ -21485,7 +21452,7 @@ paths: type: number runner_groups: type: array - items: &127 + items: &131 type: object properties: id: @@ -21602,7 +21569,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: - - *99 + - *61 requestBody: required: true content: @@ -21675,9 +21642,9 @@ paths: description: Response content: application/json: - schema: *127 + schema: *131 examples: - default: &129 + default: &133 value: id: 2 name: octo-runner-group @@ -21712,8 +21679,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: - - *99 - - &128 + - *61 + - &132 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -21725,7 +21692,7 @@ paths: description: Response content: application/json: - schema: *127 + schema: *131 examples: default: value: @@ -21761,8 +21728,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: - - *99 - - *128 + - *61 + - *132 requestBody: required: true content: @@ -21818,9 +21785,9 @@ paths: description: Response content: application/json: - schema: *127 + schema: *131 examples: - default: *129 + default: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21839,8 +21806,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: - - *99 - - *128 + - *61 + - *132 responses: '204': description: Response @@ -21863,8 +21830,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: - - *99 - - *128 + - *61 + - *132 - *17 - *19 responses: @@ -21882,11 +21849,11 @@ paths: type: number runners: type: array - items: *107 + items: *106 examples: - default: *130 + default: *134 headers: - Link: *57 + Link: *52 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21906,8 +21873,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: - - *99 - - *128 + - *61 + - *132 - *19 - *17 responses: @@ -21925,9 +21892,9 @@ paths: type: number repositories: type: array - items: *131 + items: *135 examples: - default: &634 + default: &639 value: total_count: 1 repositories: @@ -22179,8 +22146,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: - - *99 - - *128 + - *61 + - *132 requestBody: required: true content: @@ -22224,9 +22191,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: - - *99 - - *128 - - *120 + - *61 + - *132 + - *124 responses: '204': description: Response @@ -22248,9 +22215,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: - - *99 - - *128 - - *120 + - *61 + - *132 + - *124 responses: '204': description: Response @@ -22273,8 +22240,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: - - *99 - - *128 + - *61 + - *132 - *17 - *19 responses: @@ -22292,7 +22259,7 @@ paths: type: number runners: type: array - items: &133 + items: &137 title: Self hosted runners description: A self hosted runner type: object @@ -22326,7 +22293,7 @@ paths: type: boolean labels: type: array - items: &136 + items: &140 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -22356,7 +22323,7 @@ paths: - busy - labels examples: - default: &134 + default: &138 value: total_count: 2 runners: @@ -22396,7 +22363,7 @@ paths: name: no-gpu type: custom headers: - Link: *57 + Link: *52 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22415,8 +22382,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: - - *99 - - *128 + - *61 + - *132 requestBody: required: true content: @@ -22460,9 +22427,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: - - *99 - - *128 - - &132 + - *61 + - *132 + - &136 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -22490,9 +22457,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: - - *99 - - *128 + - *61 - *132 + - *136 responses: '204': description: Response @@ -22522,7 +22489,7 @@ paths: in: query schema: type: string - - *99 + - *61 - *17 - *19 responses: @@ -22540,11 +22507,11 @@ paths: type: integer runners: type: array - items: *133 + items: *137 examples: - default: *134 + default: *138 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22566,7 +22533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -22574,7 +22541,7 @@ paths: application/json: schema: type: array - items: &345 + items: &340 title: Runner Application description: Runner Application type: object @@ -22599,7 +22566,7 @@ paths: - download_url - filename examples: - default: &346 + default: &341 value: - os: osx architecture: x64 @@ -22642,7 +22609,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: - - *99 + - *61 requestBody: required: true content: @@ -22685,7 +22652,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &347 + '201': &342 description: Response content: application/json: @@ -22695,7 +22662,7 @@ paths: - runner - encoded_jit_config properties: - runner: *133 + runner: *137 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -22752,13 +22719,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *99 + - *61 responses: '201': description: Response content: application/json: - schema: &135 + schema: &139 title: Authentication Token description: Authentication Token type: object @@ -22782,7 +22749,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *66 + items: *64 single_file: type: - string @@ -22800,7 +22767,7 @@ paths: - token - expires_at examples: - default: &348 + default: &343 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -22831,15 +22798,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *99 + - *61 responses: '201': description: Response content: application/json: - schema: *135 + schema: *139 examples: - default: &349 + default: &344 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -22864,16 +22831,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: - - *99 - - *132 + - *61 + - *136 responses: '200': description: Response content: application/json: - schema: *133 + schema: *137 examples: - default: &350 + default: &345 value: id: 23 name: MBP @@ -22914,8 +22881,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: - - *99 - - *132 + - *61 + - *136 responses: '204': description: Response @@ -22941,10 +22908,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: - - *99 - - *132 + - *61 + - *136 responses: - '200': &137 + '200': &141 description: Response content: application/json: @@ -22958,7 +22925,7 @@ paths: type: integer labels: type: array - items: *136 + items: *140 examples: default: value: @@ -22997,8 +22964,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: - - *99 - - *132 + - *61 + - *136 requestBody: required: true content: @@ -23022,7 +22989,7 @@ paths: - gpu - accelerated responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -23046,8 +23013,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: - - *99 - - *132 + - *61 + - *136 requestBody: required: true content: @@ -23072,7 +23039,7 @@ paths: - gpu - accelerated responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -23096,10 +23063,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: - - *99 - - *132 + - *61 + - *136 responses: - '200': &351 + '200': &346 description: Response content: application/json: @@ -23113,7 +23080,7 @@ paths: type: integer labels: type: array - items: *136 + items: *140 examples: default: value: @@ -23154,9 +23121,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: - - *99 - - *132 - - &352 + - *61 + - *136 + - &347 name: name description: The name of a self-hosted runner's custom label. in: path @@ -23164,7 +23131,7 @@ paths: schema: type: string responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -23189,7 +23156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *99 + - *61 - *17 - *19 responses: @@ -23207,7 +23174,7 @@ paths: type: integer secrets: type: array - items: &138 + items: &142 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -23259,7 +23226,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23282,13 +23249,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &364 + schema: &359 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -23323,7 +23290,7 @@ paths: - key_id - key examples: - default: &365 + default: &360 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23348,8 +23315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *99 - - &139 + - *61 + - &143 name: secret_name description: The name of the secret. in: path @@ -23361,7 +23328,7 @@ paths: description: Response content: application/json: - schema: *138 + schema: *142 examples: default: value: @@ -23391,8 +23358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -23449,7 +23416,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -23475,8 +23442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 responses: '204': description: Response @@ -23502,8 +23469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - *19 - *17 responses: @@ -23521,9 +23488,9 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: &143 + default: &147 value: total_count: 1 repositories: @@ -23615,8 +23582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -23668,8 +23635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -23702,8 +23669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -23735,8 +23702,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *99 - - &333 + - *61 + - &328 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)." @@ -23760,7 +23727,7 @@ paths: type: integer variables: type: array - items: &141 + items: &145 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -23829,7 +23796,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23850,7 +23817,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *99 + - *61 requestBody: required: true content: @@ -23898,7 +23865,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -23923,8 +23890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *99 - - &142 + - *61 + - &146 name: name description: The name of the variable. in: path @@ -23936,7 +23903,7 @@ paths: description: Response content: application/json: - schema: *141 + schema: *145 examples: default: value: @@ -23966,8 +23933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 requestBody: required: true content: @@ -24029,8 +23996,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 responses: '204': description: Response @@ -24056,8 +24023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 - *19 - *17 responses: @@ -24075,9 +24042,9 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: *143 + default: *147 '409': description: Response when the visibility of the variable is not set to `selected` @@ -24103,8 +24070,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 requestBody: required: true content: @@ -24153,8 +24120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 - name: repository_id in: path required: true @@ -24188,8 +24155,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *99 - - *142 + - *61 + - *146 - name: repository_id in: path required: true @@ -24220,7 +24187,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *99 + - *61 requestBody: required: true content: @@ -24362,7 +24329,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *99 + - *61 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24448,7 +24415,7 @@ paths: - *17 - *38 - *39 - - *99 + - *61 requestBody: required: true content: @@ -24471,12 +24438,12 @@ paths: required: - subject_digests examples: - default: &662 + default: &666 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &663 + withPredicateType: &667 value: subject_digests: - sha256:abc123 @@ -24535,7 +24502,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &664 + default: &668 value: attestations_subject_digests: - sha256:abc: @@ -24644,7 +24611,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *99 + - *61 requestBody: required: true content: @@ -24709,7 +24676,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *99 + - *61 - name: subject_digest description: Subject Digest in: path @@ -24728,6 +24695,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 + - *38 + - *39 + - *61 + - 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 @@ -24740,7 +24758,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *99 + - *61 - name: attestation_id description: Attestation ID in: path @@ -24778,7 +24796,7 @@ paths: - *17 - *38 - *39 - - *99 + - *61 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24831,7 +24849,7 @@ paths: initiator: type: string examples: - default: &378 + default: &373 value: attestations: - bundle: @@ -24938,7 +24956,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *99 + - *61 - *17 - *19 responses: @@ -24950,7 +24968,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24969,8 +24987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: If the user is blocked @@ -24995,8 +25013,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -25016,8 +25034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -25042,7 +25060,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *99 + - *61 - *19 - *17 - *46 @@ -25050,7 +25068,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &144 + schema: &148 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -25076,7 +25094,7 @@ paths: application/json: schema: type: array - items: &145 + items: &149 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -25107,7 +25125,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &161 + items: &169 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -25184,7 +25202,7 @@ paths: parent: anyOf: - type: 'null' - - &214 + - &220 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -25320,7 +25338,7 @@ paths: - string - 'null' format: date-time - state: *144 + state: *148 contact_link: description: The contact link of the campaign. type: @@ -25416,9 +25434,9 @@ paths: closed_at: state: open headers: - Link: *57 + Link: *52 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25442,7 +25460,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -25489,7 +25507,9 @@ paths: format: uri code_scanning_alerts: description: The code scanning alerts to include in this campaign - type: array + type: + - array + - 'null' minItems: 1 items: type: object @@ -25516,7 +25536,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -25537,9 +25561,9 @@ paths: description: Response content: application/json: - schema: *145 + schema: *149 examples: - default: &146 + default: &150 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -25588,7 +25612,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25610,7 +25634,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *99 + - *61 - name: campaign_number description: The campaign number. in: path @@ -25622,16 +25646,16 @@ paths: description: Response content: application/json: - schema: *145 + schema: *149 examples: - default: *146 + default: *150 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25652,7 +25676,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *99 + - *61 - name: campaign_number description: The campaign number. in: path @@ -25702,7 +25726,7 @@ paths: - string - 'null' format: uri - state: *144 + state: *148 examples: default: value: @@ -25712,9 +25736,9 @@ paths: description: Response content: application/json: - schema: *145 + schema: *149 examples: - default: *146 + default: *150 '400': description: Bad Request content: @@ -25726,7 +25750,7 @@ paths: content: application/json: schema: *3 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25747,7 +25771,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *99 + - *61 - name: campaign_number description: The campaign number. in: path @@ -25758,7 +25782,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25780,18 +25804,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *99 - - &402 + - *61 + - &397 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: &149 + schema: &158 type: string description: The name of the tool used to generate the code scanning analysis. - - &403 + - &398 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 @@ -25799,7 +25823,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &150 + schema: &159 type: - string - 'null' @@ -25815,7 +25839,7 @@ paths: be returned. in: query required: false - schema: &405 + schema: &400 type: string description: State of a code scanning alert. enum: @@ -25838,7 +25862,7 @@ paths: be returned. in: query required: false - schema: &406 + schema: &401 type: string description: Severity of a code scanning alert. enum: @@ -25859,18 +25883,18 @@ paths: items: type: object properties: - number: *52 - created_at: *53 - updated_at: *54 - url: *55 - html_url: *56 - instances_url: &407 + number: *151 + created_at: *152 + updated_at: *153 + url: *154 + html_url: *155 + instances_url: &402 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &151 + state: &160 type: - string - 'null' @@ -25880,13 +25904,13 @@ paths: - dismissed - fixed - - fixed_at: *147 + fixed_at: *156 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *148 - dismissed_reason: &408 + dismissed_at: *157 + dismissed_reason: &403 type: - string - 'null' @@ -25897,14 +25921,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &409 + dismissed_comment: &404 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &410 + rule: &405 type: object properties: id: @@ -25965,26 +25989,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &411 + tool: &406 type: object properties: - name: *149 + name: *158 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *150 - most_recent_instance: &412 + guid: *159 + most_recent_instance: &407 type: object properties: - ref: &404 + ref: &399 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &422 + analysis_key: &417 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -25995,13 +26019,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &423 + category: &418 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: *151 + state: *160 commit_sha: type: string message: @@ -26294,9 +26318,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: *57 + Link: *52 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26318,7 +26342,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *99 + - *61 - name: target_type in: query description: The target type of the code security configuration @@ -26429,7 +26453,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *99 + - *61 requestBody: required: true content: @@ -26507,7 +26531,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *152 + code_scanning_options: *161 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -26650,7 +26674,7 @@ paths: application/json: schema: *41 examples: - default: *153 + default: *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26672,15 +26696,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: *154 + schema: *163 examples: - default: *155 + default: *164 '304': *35 '403': *27 '404': *6 @@ -26706,7 +26730,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *99 + - *61 requestBody: required: true content: @@ -26732,7 +26756,7 @@ paths: - 32 - 91 responses: - '204': *156 + '204': *165 '400': *14 '403': *27 '404': *6 @@ -26758,7 +26782,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *99 + - *61 - *43 responses: '200': @@ -26767,7 +26791,7 @@ paths: application/json: schema: *41 examples: - default: *153 + default: *162 '304': *35 '403': *27 '404': *6 @@ -26791,7 +26815,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *99 + - *61 - *43 requestBody: required: true @@ -27048,10 +27072,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *99 + - *61 - *43 responses: - '204': *156 + '204': *165 '400': *14 '403': *27 '404': *6 @@ -27079,7 +27103,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *99 + - *61 - *43 requestBody: required: true @@ -27143,7 +27167,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: - - *99 + - *61 - *43 requestBody: required: true @@ -27189,7 +27213,7 @@ paths: default: value: default_for_new_repos: all - configuration: *153 + configuration: *162 '403': *27 '404': *6 x-github: @@ -27213,7 +27237,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *99 + - *61 - *43 - name: per_page description: The number of results per page (max 100). For more information, @@ -27242,13 +27266,13 @@ paths: application/json: schema: type: array - items: *157 + items: *166 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *158 + repository: *167 '403': *27 '404': *6 x-github: @@ -27272,7 +27296,7 @@ paths: parameters: - *17 - *19 - - *99 + - *61 responses: '200': description: Response @@ -27288,7 +27312,7 @@ paths: type: integer codespaces: type: array - items: &204 + items: &210 type: object title: Codespace description: A codespace. @@ -27319,11 +27343,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *131 + repository: *135 machine: anyOf: - type: 'null' - - &435 + - &430 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -27610,7 +27634,7 @@ paths: - pulls_url - recent_folders examples: - default: &205 + default: &211 value: total_count: 3 codespaces: @@ -28020,7 +28044,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -28042,7 +28066,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *99 + - *61 deprecated: true requestBody: required: true @@ -28086,7 +28110,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28109,7 +28133,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *99 + - *61 deprecated: true requestBody: required: true @@ -28141,7 +28165,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28164,7 +28188,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *99 + - *61 requestBody: required: true content: @@ -28195,7 +28219,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28216,7 +28240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *99 + - *61 - *17 - *19 responses: @@ -28234,7 +28258,7 @@ paths: type: integer secrets: type: array - items: &159 + items: &168 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -28275,7 +28299,7 @@ paths: - updated_at - visibility examples: - default: &436 + default: &431 value: total_count: 2 secrets: @@ -28288,7 +28312,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28307,13 +28331,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &437 + schema: &432 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -28348,7 +28372,7 @@ paths: - key_id - key examples: - default: &438 + default: &433 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28371,23 +28395,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 responses: '200': description: Response content: application/json: - schema: *159 + schema: *168 examples: - default: &440 + default: &435 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28407,8 +28431,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -28463,7 +28487,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -28489,8 +28513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 responses: '204': description: Response @@ -28515,8 +28539,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - *19 - *17 responses: @@ -28534,9 +28558,9 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: *143 + default: *147 '404': *6 x-github: githubCloudOnly: false @@ -28558,8 +28582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -28609,8 +28633,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -28643,8 +28667,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -28683,7 +28707,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: - - *99 + - *61 responses: '200': description: OK @@ -28792,7 +28816,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -28824,7 +28848,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: - - *99 + - *61 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -28847,7 +28871,7 @@ paths: currently being billed. seats: type: array - items: &207 + items: &213 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -28860,13 +28884,13 @@ paths: organization: anyOf: - type: 'null' - - *160 + - *59 assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *161 - - *58 + - *169 + - *53 type: - 'null' - object @@ -28996,8 +29020,8 @@ paths: type: User site_admin: false headers: - Link: *57 - '500': *100 + Link: *52 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -29030,7 +29054,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: - - *99 + - *61 requestBody: content: application/json: @@ -29072,7 +29096,7 @@ paths: default: value: seats_created: 5 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -29108,7 +29132,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: - - *99 + - *61 requestBody: content: application/json: @@ -29150,7 +29174,7 @@ paths: default: value: seats_cancelled: 5 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -29188,7 +29212,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: - - *99 + - *61 requestBody: content: application/json: @@ -29229,7 +29253,7 @@ paths: default: value: seats_created: 5 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -29265,7 +29289,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: - - *99 + - *61 requestBody: content: application/json: @@ -29307,7 +29331,7 @@ paths: default: value: seats_cancelled: 5 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -29346,7 +29370,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *99 + - *61 - 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`). @@ -29378,7 +29402,7 @@ paths: application/json: schema: type: array - items: &296 + items: &291 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -29693,7 +29717,7 @@ paths: - date additionalProperties: true examples: - default: &297 + default: &292 value: - date: '2024-06-24' total_active_users: 24 @@ -29792,10 +29816,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *100 + '500': *98 '403': *27 '404': *6 - '422': &298 + '422': &293 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -29822,12 +29846,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *99 - - *162 - - *163 - - *164 - - *165 - - *166 + - *61 + - *170 + - *171 + - *172 + - *173 + - *174 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -29865,13 +29889,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *167 - - *168 + - *175 + - *176 - *46 - *38 - *39 - - *169 - - *170 - *17 responses: '200': @@ -29880,9 +29902,9 @@ paths: application/json: schema: type: array - items: *171 + items: *177 examples: - default: *172 + default: *178 '304': *35 '400': *14 '403': *27 @@ -29908,7 +29930,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *99 + - *61 - *17 - *19 responses: @@ -29926,7 +29948,7 @@ paths: type: integer secrets: type: array - items: &173 + items: &179 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -29978,7 +30000,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29999,13 +30021,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &463 + schema: &458 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -30024,7 +30046,7 @@ paths: - key_id - key examples: - default: &464 + default: &459 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -30047,14 +30069,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 responses: '200': description: Response content: application/json: - schema: *173 + schema: *179 examples: default: value: @@ -30082,8 +30104,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -30142,7 +30164,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -30166,8 +30188,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 responses: '204': description: Response @@ -30191,8 +30213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - *19 - *17 responses: @@ -30210,9 +30232,9 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: *143 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30233,8 +30255,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -30284,8 +30306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -30316,8 +30338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *99 - - *139 + - *61 + - *143 - name: repository_id in: path required: true @@ -30347,7 +30369,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: - - *99 + - *61 responses: '200': description: Response @@ -30355,7 +30377,7 @@ paths: application/json: schema: type: array - items: &216 + items: &222 title: Package description: A software package type: object @@ -30408,7 +30430,7 @@ paths: repository: anyOf: - type: 'null' - - *131 + - *135 created_at: type: string format: date-time @@ -30426,7 +30448,7 @@ paths: - created_at - updated_at examples: - default: &217 + default: &223 value: - id: 197 name: hello_docker @@ -30504,7 +30526,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *99 + - *61 - *17 - *19 responses: @@ -30514,7 +30536,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: 200-response: value: @@ -30586,7 +30608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *99 + - *61 - *17 - *19 responses: @@ -30596,7 +30618,7 @@ paths: application/json: schema: type: array - items: &196 + items: &202 title: Organization Invitation description: Organization Invitation type: object @@ -30650,7 +30672,7 @@ paths: - invitation_teams_url - node_id examples: - default: &197 + default: &203 value: - id: 1 login: monalisa @@ -30683,7 +30705,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -30707,7 +30729,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *99 + - *61 - *17 - *19 responses: @@ -30717,7 +30739,7 @@ paths: application/json: schema: type: array - items: &174 + items: &180 title: Org Hook description: Org Hook type: object @@ -30817,7 +30839,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -30840,7 +30862,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *99 + - *61 requestBody: required: true content: @@ -30902,9 +30924,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *180 examples: - default: &175 + default: &181 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -30951,8 +30973,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *99 - - &176 + - *61 + - &182 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. @@ -30965,9 +30987,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *180 examples: - default: *175 + default: *181 '404': *6 x-github: githubCloudOnly: false @@ -30994,8 +31016,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 requestBody: required: false content: @@ -31041,7 +31063,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *180 examples: default: value: @@ -31082,8 +31104,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 responses: '204': description: Response @@ -31110,8 +31132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *99 - - *176 + - *61 + - *182 responses: '200': description: Response @@ -31141,8 +31163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *99 - - *176 + - *61 + - *182 requestBody: required: false content: @@ -31192,10 +31214,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 - *17 - - *177 + - *183 responses: '200': description: Response @@ -31203,9 +31225,9 @@ paths: application/json: schema: type: array - items: *178 + items: *184 examples: - default: *179 + default: *185 '400': *14 '422': *15 x-github: @@ -31230,17 +31252,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 - *16 responses: '200': description: Response content: application/json: - schema: *180 + schema: *186 examples: - default: *181 + default: *187 '400': *14 '422': *15 x-github: @@ -31265,8 +31287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 - *16 responses: '202': *37 @@ -31295,8 +31317,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *99 - - *176 + - *61 + - *182 responses: '204': description: Response @@ -31318,8 +31340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *99 - - &186 + - *61 + - &192 name: actor_type in: path description: The type of the actor @@ -31332,14 +31354,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &187 + - &193 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &182 + - &188 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`.' @@ -31347,7 +31369,7 @@ paths: required: true schema: type: string - - &183 + - &189 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) @@ -31441,13 +31463,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *99 - - *182 - - *183 + - *61 + - *188 + - *189 - *19 - *17 - *46 - - &192 + - &198 name: sort description: The property to sort the results by. in: query @@ -31526,15 +31548,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *99 - - *182 - - *183 + - *61 + - *188 + - *189 responses: '200': description: Response content: application/json: - schema: &184 + schema: &190 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -31550,7 +31572,7 @@ paths: type: integer format: int64 examples: - default: &185 + default: &191 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -31570,24 +31592,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *99 - - &188 + - *61 + - &194 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *182 - - *183 + - *188 + - *189 responses: '200': description: Response content: application/json: - schema: *184 + schema: *190 examples: - default: *185 + default: *191 x-github: enabledForGitHubApps: true category: orgs @@ -31605,19 +31627,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *99 - - *182 - - *183 - - *186 - - *187 + - *61 + - *188 + - *189 + - *192 + - *193 responses: '200': description: Response content: application/json: - schema: *184 + schema: *190 examples: - default: *185 + default: *191 x-github: enabledForGitHubApps: true category: orgs @@ -31634,10 +31656,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *99 - - *182 - - *183 - - &189 + - *61 + - *188 + - *189 + - &195 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -31650,7 +31672,7 @@ paths: description: Response content: application/json: - schema: &190 + schema: &196 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -31666,7 +31688,7 @@ paths: type: integer format: int64 examples: - default: &191 + default: &197 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -31702,19 +31724,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *99 + - *61 + - *194 - *188 - - *182 - - *183 - *189 + - *195 responses: '200': description: Response content: application/json: - schema: *190 + schema: *196 examples: - default: *191 + default: *197 x-github: enabledForGitHubApps: true category: orgs @@ -31731,20 +31753,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *99 - - *186 - - *187 - - *182 - - *183 + - *61 + - *192 + - *193 + - *188 - *189 + - *195 responses: '200': description: Response content: application/json: - schema: *190 + schema: *196 examples: - default: *191 + default: *197 x-github: enabledForGitHubApps: true category: orgs @@ -31761,14 +31783,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *99 + - *61 + - *194 - *188 - - *182 - - *183 + - *189 - *19 - *17 - *46 - - *192 + - *198 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -31844,7 +31866,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *99 + - *61 responses: '200': description: Response @@ -31852,7 +31874,7 @@ paths: application/json: schema: *20 examples: - default: &502 + default: &497 value: id: 1 account: @@ -31921,7 +31943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *99 + - *61 - *17 - *19 responses: @@ -31991,7 +32013,7 @@ paths: suspended_at: suspended_by: headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32010,7 +32032,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -32018,12 +32040,12 @@ paths: application/json: schema: anyOf: - - &194 + - &200 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &193 + limit: &199 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -32051,7 +32073,7 @@ paths: properties: {} additionalProperties: false examples: - default: &195 + default: &201 value: limit: collaborators_only origin: organization @@ -32075,18 +32097,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: application/json: - schema: &503 + schema: &498 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *193 + limit: *199 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -32111,9 +32133,9 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: - default: *195 + default: *201 '422': *15 x-github: githubCloudOnly: false @@ -32131,7 +32153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Response @@ -32155,7 +32177,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *99 + - *61 - *17 - *19 - name: role @@ -32189,11 +32211,11 @@ paths: application/json: schema: type: array - items: *196 + items: *202 examples: - default: *197 + default: *203 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -32214,7 +32236,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *99 + - *61 requestBody: required: false content: @@ -32268,7 +32290,7 @@ paths: description: Response content: application/json: - schema: *196 + schema: *202 examples: default: value: @@ -32322,8 +32344,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *99 - - &198 + - *61 + - &204 name: invitation_id description: The unique identifier of the invitation. in: path @@ -32353,8 +32375,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *99 - - *198 + - *61 + - *204 - *17 - *19 responses: @@ -32364,9 +32386,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: &215 + default: &221 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -32382,7 +32404,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -32401,7 +32423,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -32409,7 +32431,7 @@ paths: application/json: schema: type: array - items: *199 + items: *205 examples: default: value: @@ -32447,7 +32469,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -32497,9 +32519,9 @@ paths: description: Response content: application/json: - schema: *199 + schema: *205 examples: - default: &200 + default: &206 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -32531,8 +32553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *99 - - &201 + - *61 + - &207 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -32588,9 +32610,9 @@ paths: description: Response content: application/json: - schema: *199 + schema: *205 examples: - default: *200 + default: *206 '404': *6 '422': *7 x-github: @@ -32614,8 +32636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *99 - - *201 + - *61 + - *207 responses: '204': description: Response @@ -32648,7 +32670,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *99 + - *61 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -32678,7 +32700,7 @@ paths: - closed - all default: open - - *202 + - *208 - name: type description: Can be the name of an issue type. in: query @@ -32697,7 +32719,7 @@ paths: - comments default: created - *46 - - *75 + - *72 - *17 - *19 responses: @@ -32707,11 +32729,11 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: *203 + default: *209 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -32731,7 +32753,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *99 + - *61 - 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) @@ -32769,9 +32791,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '422': *15 x-github: githubCloudOnly: false @@ -32789,8 +32811,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response if requester is an organization member and user is @@ -32824,8 +32846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -32851,8 +32873,8 @@ paths: parameters: - *17 - *19 - - *99 - - *62 + - *61 + - *57 responses: '200': description: Response @@ -32868,11 +32890,11 @@ paths: type: integer codespaces: type: array - items: *204 + items: *210 examples: - default: *205 + default: *211 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -32895,9 +32917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *99 - - *62 - - &206 + - *61 + - *57 + - &212 name: codespace_name in: path required: true @@ -32907,7 +32929,7 @@ paths: responses: '202': *37 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -32930,17 +32952,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *99 - - *62 - - *206 + - *61 + - *57 + - *212 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: &434 + default: &429 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -33082,7 +33104,7 @@ paths: recent_folders: [] template: '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -33113,14 +33135,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: - - *99 - - *62 + - *61 + - *57 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *207 + schema: *213 examples: default: value: @@ -33164,7 +33186,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -33189,14 +33211,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '200': description: Response content: application/json: - schema: &208 + schema: &214 title: Org Membership description: Org Membership type: object @@ -33245,7 +33267,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *160 + organization: *59 user: anyOf: - type: 'null' @@ -33265,7 +33287,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &209 + response-if-user-has-an-active-admin-membership-with-organization: &215 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -33333,8 +33355,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 requestBody: required: false content: @@ -33362,9 +33384,9 @@ paths: description: Response content: application/json: - schema: *208 + schema: *214 examples: - response-if-user-already-had-membership-with-organization: *209 + response-if-user-already-had-membership-with-organization: *215 '422': *15 '403': *27 x-github: @@ -33388,8 +33410,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -33414,7 +33436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *99 + - *61 - *17 - *19 - name: exclude @@ -33436,7 +33458,7 @@ paths: application/json: schema: type: array - items: &210 + items: &216 title: Migration description: A migration. type: object @@ -33478,7 +33500,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *66 + items: *64 url: type: string format: uri @@ -33677,7 +33699,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33693,7 +33715,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *99 + - *61 requestBody: required: true content: @@ -33774,7 +33796,7 @@ paths: description: Response content: application/json: - schema: *210 + schema: *216 examples: default: value: @@ -33952,8 +33974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *99 - - &211 + - *61 + - &217 name: migration_id description: The unique identifier of the migration. in: path @@ -33981,7 +34003,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *210 + schema: *216 examples: default: value: @@ -34150,8 +34172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *99 - - *211 + - *61 + - *217 responses: '302': description: Response @@ -34172,8 +34194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *99 - - *211 + - *61 + - *217 responses: '204': description: Response @@ -34196,9 +34218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *99 - - *211 - - &646 + - *61 + - *217 + - &651 name: repo_name description: repo_name parameter in: path @@ -34225,8 +34247,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *99 - - *211 + - *61 + - *217 - *17 - *19 responses: @@ -34236,9 +34258,9 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: &222 + default: &228 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -34349,7 +34371,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -34375,7 +34397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response - list of organization roles @@ -34391,7 +34413,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &213 + items: &219 title: Organization Role description: Organization roles type: object @@ -34540,8 +34562,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *99 - - *64 + - *61 + - *62 responses: '204': description: Response @@ -34566,9 +34588,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *99 - - *64 - - &212 + - *61 + - *62 + - &218 name: role_id description: The unique identifier of the role. in: path @@ -34603,9 +34625,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *99 - - *64 - - *212 + - *61 + - *62 + - *218 responses: '204': description: Response @@ -34630,8 +34652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -34656,9 +34678,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *99 - - *62 - - *212 + - *61 + - *57 + - *218 responses: '204': description: Response @@ -34688,9 +34710,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *99 - - *62 - - *212 + - *61 + - *57 + - *218 responses: '204': description: Response @@ -34718,14 +34740,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *99 - - *212 + - *61 + - *218 responses: '200': description: Response content: application/json: - schema: *213 + schema: *219 examples: default: value: @@ -34775,8 +34797,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: - - *99 - - *212 + - *61 + - *218 - *17 - *19 responses: @@ -34855,7 +34877,7 @@ paths: parent: anyOf: - type: 'null' - - *214 + - *220 type: description: The ownership type of the team type: string @@ -34888,9 +34910,9 @@ paths: - type - parent examples: - default: *215 + default: *221 headers: - Link: *57 + Link: *52 '404': description: Response if the organization or role does not exist. '422': @@ -34917,8 +34939,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: - - *99 - - *212 + - *61 + - *218 - *17 - *19 responses: @@ -34947,7 +34969,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *214 + items: *220 name: type: - string @@ -35064,9 +35086,9 @@ paths: - type - url examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '404': description: Response if the organization or role does not exist. '422': @@ -35088,7 +35110,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *99 + - *61 - 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) @@ -35115,9 +35137,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35140,8 +35162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *99 - - *62 + - *61 + - *57 requestBody: required: false content: @@ -35198,8 +35220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -35256,8 +35278,8 @@ paths: - docker - nuget - container - - *99 - - &648 + - *61 + - &652 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -35293,12 +35315,12 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *217 + default: *223 '403': *27 '401': *23 - '400': &650 + '400': &654 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -35320,7 +35342,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &218 + - &224 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 @@ -35338,20 +35360,20 @@ paths: - docker - nuget - container - - &219 + - &225 name: package_name description: The name of the package. in: path required: true schema: type: string - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: *216 + schema: *222 examples: default: value: @@ -35403,9 +35425,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *218 - - *219 - - *99 + - *224 + - *225 + - *61 responses: '204': description: Response @@ -35437,9 +35459,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *218 - - *219 - - *99 + - *224 + - *225 + - *61 - name: token description: package token schema: @@ -35471,9 +35493,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: - - *218 - - *219 - - *99 + - *224 + - *225 + - *61 - *19 - *17 - name: state @@ -35493,7 +35515,7 @@ paths: application/json: schema: type: array - items: &220 + items: &226 title: Package Version description: A version of a software package type: object @@ -35628,10 +35650,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *218 - - *219 - - *99 - - &221 + - *224 + - *225 + - *61 + - &227 name: package_version_id description: Unique identifier of the package version. in: path @@ -35643,7 +35665,7 @@ paths: description: Response content: application/json: - schema: *220 + schema: *226 examples: default: value: @@ -35679,10 +35701,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *218 - - *219 - - *99 - - *221 + - *224 + - *225 + - *61 + - *227 responses: '204': description: Response @@ -35714,10 +35736,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *218 - - *219 - - *99 - - *221 + - *224 + - *225 + - *61 + - *227 responses: '204': description: Response @@ -35744,10 +35766,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: - - *99 + - *61 - *17 - *19 - - &223 + - &229 name: sort description: The property by which to sort the results. in: query @@ -35758,7 +35780,7 @@ paths: - created_at default: created_at - *46 - - &224 + - &230 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -35770,7 +35792,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &225 + - &231 name: repository description: The name of the repository to use to filter the results. in: query @@ -35779,7 +35801,7 @@ paths: type: string examples: - Hello-World - - &226 + - &232 name: permission description: The permission to use to filter the results. in: query @@ -35788,7 +35810,7 @@ paths: type: string examples: - issues_read - - &227 + - &233 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) @@ -35798,7 +35820,7 @@ paths: schema: type: string format: date-time - - &228 + - &234 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) @@ -35808,7 +35830,7 @@ paths: schema: type: string format: date-time - - &229 + - &235 name: token_id description: The ID of the token in: query @@ -35821,7 +35843,7 @@ paths: examples: - token_id[]=1,token_id[]=2 responses: - '500': *100 + '500': *98 '422': *15 '404': *6 '403': *27 @@ -35956,7 +35978,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35976,7 +35998,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: - - *99 + - *61 requestBody: required: true content: @@ -36018,7 +36040,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *100 + '500': *98 '422': *15 '404': *6 '403': *27 @@ -36043,7 +36065,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: - - *99 + - *61 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -36080,11 +36102,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *100 + '500': *98 '422': *15 '404': *6 '403': *27 - '204': *156 + '204': *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36105,7 +36127,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: - - *99 + - *61 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -36116,7 +36138,7 @@ paths: - *17 - *19 responses: - '500': *100 + '500': *98 '404': *6 '403': *27 '200': @@ -36125,11 +36147,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36150,19 +36172,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: - - *99 + - *61 - *17 - *19 - - *223 - - *46 - - *224 - - *225 - - *226 - - *227 - - *228 - *229 + - *46 + - *230 + - *231 + - *232 + - *233 + - *234 + - *235 responses: - '500': *100 + '500': *98 '422': *15 '404': *6 '403': *27 @@ -36291,7 +36313,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36311,7 +36333,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: - - *99 + - *61 requestBody: required: true content: @@ -36346,7 +36368,7 @@ paths: - 1296269 - 1296280 responses: - '500': *100 + '500': *98 '404': *6 '202': *37 '403': *27 @@ -36371,7 +36393,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: - - *99 + - *61 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -36399,9 +36421,9 @@ paths: value: action: revoke responses: - '500': *100 + '500': *98 '404': *6 - '204': *156 + '204': *165 '403': *27 '422': *15 x-github: @@ -36423,7 +36445,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: - - *99 + - *61 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -36433,7 +36455,7 @@ paths: - *17 - *19 responses: - '500': *100 + '500': *98 '404': *6 '403': *27 '200': @@ -36442,11 +36464,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36468,7 +36490,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *99 + - *61 - *17 - *19 responses: @@ -36486,7 +36508,7 @@ paths: type: integer configurations: type: array - items: &230 + items: &236 title: Organization private registry description: Private registry configuration for an organization type: object @@ -36555,7 +36577,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *57 + Link: *52 '400': *14 '404': *6 x-github: @@ -36577,7 +36599,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -36745,7 +36767,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &231 + org-private-registry-with-selected-visibility: &237 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -36786,7 +36808,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: - - *99 + - *61 responses: '200': description: Response @@ -36814,7 +36836,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -36836,16 +36858,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *99 - - *139 + - *61 + - *143 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *230 + schema: *236 examples: - default: *231 + default: *237 '404': *6 x-github: githubCloudOnly: false @@ -36866,8 +36888,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *99 - - *139 + - *61 + - *143 requestBody: required: true content: @@ -36963,8 +36985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *99 - - *139 + - *61 + - *143 responses: '204': description: Response @@ -36989,7 +37011,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-organization-projects parameters: - - *99 + - *61 - name: state description: Indicates the state of the projects to return. in: query @@ -37010,7 +37032,7 @@ paths: application/json: schema: type: array - items: &232 + items: &238 title: Project description: Projects are a way to organize columns and cards of work. @@ -37143,7 +37165,7 @@ paths: organization_permission: write private: true headers: - Link: *57 + Link: *52 '422': *7 x-github: githubCloudOnly: false @@ -37166,7 +37188,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-an-organization-project parameters: - - *99 + - *61 requestBody: required: true content: @@ -37192,7 +37214,7 @@ paths: description: Response content: application/json: - schema: *232 + schema: *238 examples: default: value: @@ -37230,7 +37252,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &320 + '410': &315 description: Gone content: application/json: @@ -37256,7 +37278,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *99 + - *61 - name: q description: Limit results to projects of the specified type. in: query @@ -37273,7 +37295,7 @@ paths: application/json: schema: type: array - items: &233 + items: &239 title: Projects v2 Project description: A projects v2 project type: object @@ -37347,7 +37369,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &727 + - &731 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -37432,7 +37454,7 @@ paths: - deleted_at - deleted_by examples: - default: &234 + default: &240 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -37515,7 +37537,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -37535,24 +37557,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &235 + - &241 name: project_number description: The project's number. in: path required: true schema: type: integer - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: *233 + schema: *239 examples: - default: *234 + default: *240 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -37572,8 +37594,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *235 - - *99 + - *241 + - *61 - *17 - *38 - *39 @@ -37584,7 +37606,7 @@ paths: application/json: schema: type: array - items: &236 + items: &242 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -37734,7 +37756,7 @@ paths: - updated_at - project_url examples: - default: &237 + default: &243 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37757,7 +37779,7 @@ paths: created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -37777,25 +37799,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *235 - - &667 + - *241 + - &671 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: *236 + schema: *242 examples: - default: *237 + default: *243 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -37816,8 +37838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *235 - - *99 + - *241 + - *61 - 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. @@ -37826,17 +37848,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string - *38 - *39 - *17 @@ -37847,7 +37871,7 @@ paths: application/json: schema: type: array - items: &242 + items: &248 title: Projects v2 Item description: An item belonging to a project type: object @@ -37864,7 +37888,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: &240 + content_type: &246 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -37921,7 +37945,7 @@ paths: - updated_at - archived_at examples: - default: &243 + default: &249 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -38595,7 +38619,7 @@ paths: type: sub_issues_progress value: headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -38615,8 +38639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *99 - - *235 + - *61 + - *241 requestBody: required: true description: Details of the item to add to the project. @@ -38653,7 +38677,7 @@ paths: description: Response content: application/json: - schema: &668 + schema: &672 title: Projects v2 Item description: An item belonging to a project type: object @@ -38666,8 +38690,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *68 - - &447 + - *66 + - &442 title: Pull Request Simple description: Pull Request Simple type: object @@ -38787,7 +38811,7 @@ paths: milestone: anyOf: - type: 'null' - - *238 + - *244 active_lock_reason: type: - string @@ -38842,7 +38866,7 @@ paths: type: - array - 'null' - items: *161 + items: *169 head: type: object properties: @@ -38850,7 +38874,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *64 sha: type: string user: @@ -38870,7 +38894,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *64 sha: type: string user: @@ -38886,7 +38910,7 @@ paths: _links: type: object properties: - comments: &239 + comments: &245 title: Link description: Hypermedia Link type: object @@ -38895,13 +38919,13 @@ paths: type: string required: - href - commits: *239 - statuses: *239 - html: *239 - issue: *239 - review_comments: *239 - review_comment: *239 - self: *239 + commits: *245 + statuses: *245 + html: *245 + issue: *245 + review_comments: *245 + review_comment: *245 + self: *245 required: - comments - commits @@ -38911,8 +38935,8 @@ paths: - review_comments - review_comment - self - author_association: *69 - auto_merge: &544 + author_association: *67 + auto_merge: &541 title: Auto merge description: The status of auto merging a pull request. type: @@ -39014,7 +39038,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *240 + content_type: *246 creator: *4 created_at: type: string @@ -39051,7 +39075,7 @@ paths: - updated_at - archived_at examples: - issue: &241 + issue: &247 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -39106,7 +39130,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: *241 + pull_request: *247 '304': *35 '403': *27 '401': *23 @@ -39126,9 +39150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *235 - - *99 - - &244 + - *241 + - *61 + - &250 name: item_id description: The unique identifier of the project item. in: path @@ -39136,27 +39160,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *242 + schema: *248 examples: - default: *243 + default: *249 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -39175,9 +39201,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *235 - - *99 - - *244 + - *241 + - *61 + - *250 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -39250,13 +39276,13 @@ paths: description: Response content: application/json: - schema: *242 + schema: *248 examples: - text_field: *243 - number_field: *243 - date_field: *243 - single_select_field: *243 - iteration_field: *243 + text_field: *249 + number_field: *249 + date_field: *249 + single_select_field: *249 + iteration_field: *249 '401': *23 '403': *27 '404': *6 @@ -39276,9 +39302,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *235 - - *99 - - *244 + - *241 + - *61 + - *250 responses: '204': description: Response @@ -39302,7 +39328,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response @@ -39310,7 +39336,7 @@ paths: application/json: schema: type: array - items: &245 + items: &251 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -39386,7 +39412,7 @@ paths: - property_name - value_type examples: - default: &246 + default: &252 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -39434,7 +39460,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *99 + - *61 requestBody: required: true content: @@ -39445,7 +39471,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *245 + items: *251 minItems: 1 maxItems: 100 required: @@ -39475,9 +39501,9 @@ paths: application/json: schema: type: array - items: *245 + items: *251 examples: - default: *246 + default: *252 '403': *27 '404': *6 x-github: @@ -39498,8 +39524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *99 - - &247 + - *61 + - &253 name: custom_property_name description: The custom property name in: path @@ -39511,9 +39537,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *251 examples: - default: &248 + default: &254 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -39547,8 +39573,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: - - *99 - - *247 + - *61 + - *253 requestBody: required: true content: @@ -39626,9 +39652,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *251 examples: - default: *248 + default: *254 '403': *27 '404': *6 x-github: @@ -39651,10 +39677,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *99 - - *247 + - *61 + - *253 responses: - '204': *156 + '204': *165 '403': *27 '404': *6 x-github: @@ -39675,7 +39701,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *99 + - *61 - *17 - *19 - name: repository_query @@ -39716,28 +39742,7 @@ paths: - octocat/Hello-World properties: type: array - items: &249 - 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 - type: - - 'null' - - string - - array - required: - - property_name - - value + items: *97 description: List of custom property names and associated values required: - repository_id @@ -39758,7 +39763,7 @@ paths: - property_name: team value: octocat headers: - Link: *57 + Link: *52 '403': *27 '404': *6 x-github: @@ -39786,7 +39791,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: - - *99 + - *61 requestBody: required: true content: @@ -39806,7 +39811,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *249 + items: *97 required: - repository_names - properties @@ -39847,7 +39852,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *99 + - *61 - *17 - *19 responses: @@ -39859,9 +39864,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39878,8 +39883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response if user is a public member @@ -39903,8 +39908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -39925,8 +39930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *99 - - *62 + - *61 + - *57 responses: '204': description: Response @@ -39950,7 +39955,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *99 + - *61 - name: type description: Specifies the types of repositories you want returned. in: query @@ -39996,11 +40001,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40019,7 +40024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *99 + - *61 requestBody: required: true content: @@ -40201,7 +40206,7 @@ paths: description: Response content: application/json: - schema: &322 + schema: &317 title: Full Repository description: Full Repository type: object @@ -40547,7 +40552,7 @@ paths: template_repository: anyOf: - type: 'null' - - *66 + - *64 temp_clone_token: type: - string @@ -40647,13 +40652,13 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 organization: anyOf: - type: 'null' - *4 - parent: *66 - source: *66 + parent: *64 + source: *64 forks: type: integer master_branch: @@ -40666,7 +40671,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &452 + code_of_conduct: &447 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -40696,7 +40701,7 @@ paths: - key - name - html_url - security_and_analysis: *250 + security_and_analysis: *255 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -40780,7 +40785,7 @@ paths: - network_count - subscribers_count examples: - default: &324 + default: &319 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -41298,10 +41303,10 @@ paths: category: orgs subcategory: rules parameters: - - *99 + - *61 - *17 - *19 - - &567 + - &564 name: targets description: | A comma-separated list of rule targets to filter by. @@ -41320,7 +41325,7 @@ paths: application/json: schema: type: array - items: &276 + items: &281 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -41355,7 +41360,7 @@ paths: source: type: string description: The name of the source - enforcement: &253 + enforcement: &258 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -41368,7 +41373,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &254 + items: &259 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -41439,7 +41444,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &251 + - &256 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -41463,7 +41468,7 @@ paths: match. items: type: string - - &255 + - &260 title: Organization ruleset conditions type: object description: |- @@ -41477,7 +41482,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *251 + - *256 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -41511,7 +41516,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *251 + - *256 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -41533,7 +41538,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *251 + - *256 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -41546,7 +41551,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &252 + items: &257 title: Repository ruleset property targeting definition type: object @@ -41579,7 +41584,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *252 + items: *257 required: - repository_property type: @@ -41587,12 +41592,12 @@ paths: - object rules: type: array - items: &568 + items: &565 title: Repository Rule type: object description: A repository rule. oneOf: - - &256 + - &261 title: creation description: Only allow users with bypass permission to create matching refs. @@ -41604,7 +41609,7 @@ paths: type: string enum: - creation - - &257 + - &262 title: update description: Only allow users with bypass permission to update matching refs. @@ -41625,7 +41630,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &258 + - &263 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -41637,7 +41642,7 @@ paths: type: string enum: - deletion - - &259 + - &264 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -41649,7 +41654,7 @@ paths: type: string enum: - required_linear_history - - &565 + - &562 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -41727,7 +41732,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &260 + - &265 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -41751,7 +41756,7 @@ paths: type: string required: - required_deployment_environments - - &261 + - &266 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -41763,7 +41768,7 @@ paths: type: string enum: - required_signatures - - &262 + - &267 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -41825,7 +41830,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &263 + - &268 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -41873,7 +41878,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &264 + - &269 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -41885,7 +41890,7 @@ paths: type: string enum: - non_fast_forward - - &265 + - &270 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -41921,7 +41926,7 @@ paths: required: - operator - pattern - - &266 + - &271 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -41957,7 +41962,7 @@ paths: required: - operator - pattern - - &267 + - &272 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -41993,7 +41998,7 @@ paths: required: - operator - pattern - - &268 + - &273 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -42029,7 +42034,7 @@ paths: required: - operator - pattern - - &269 + - &274 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -42065,7 +42070,7 @@ paths: required: - operator - pattern - - &270 + - &275 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -42090,7 +42095,7 @@ paths: type: string required: - restricted_file_paths - - &271 + - &276 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -42114,7 +42119,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &272 + - &277 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -42137,7 +42142,7 @@ paths: type: string required: - restricted_file_extensions - - &273 + - &278 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -42162,7 +42167,7 @@ paths: maximum: 100 required: - max_file_size - - &274 + - &279 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -42212,7 +42217,7 @@ paths: - repository_id required: - workflows - - &275 + - &280 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -42273,7 +42278,7 @@ paths: - tool required: - code_scanning_tools - - &566 + - &563 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -42334,7 +42339,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *100 + '500': *98 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -42350,7 +42355,7 @@ paths: category: orgs subcategory: rules parameters: - - *99 + - *61 requestBody: description: Request body required: true @@ -42371,25 +42376,20 @@ paths: - push - repository default: branch - enforcement: *253 + enforcement: *258 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *254 - conditions: *255 + items: *259 + conditions: *260 rules: type: array description: An array of rules within the ruleset. - items: &278 + items: &283 title: Repository Rule type: object description: A repository rule. oneOf: - - *256 - - *257 - - *258 - - *259 - - *260 - *261 - *262 - *263 @@ -42405,6 +42405,11 @@ paths: - *273 - *274 - *275 + - *276 + - *277 + - *278 + - *279 + - *280 required: - name - enforcement @@ -42442,9 +42447,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: &277 + default: &282 value: id: 21 name: super cool ruleset @@ -42484,7 +42489,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *100 + '500': *98 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -42498,8 +42503,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *99 - - &569 + - *61 + - &566 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 @@ -42514,7 +42519,7 @@ paths: in: query schema: type: string - - &570 + - &567 name: time_period description: |- The time period to filter by. @@ -42530,14 +42535,14 @@ paths: - week - month default: day - - &571 + - &568 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 - - &572 + - &569 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -42557,7 +42562,7 @@ paths: description: Response content: application/json: - schema: &573 + schema: &570 title: Rule Suites description: Response type: array @@ -42613,7 +42618,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &574 + default: &571 value: - id: 21 actor_id: 12 @@ -42637,7 +42642,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42656,8 +42661,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *99 - - &575 + - *61 + - &572 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -42673,7 +42678,7 @@ paths: description: Response content: application/json: - schema: &576 + schema: &573 title: Rule Suite description: Response type: object @@ -42780,7 +42785,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &577 + default: &574 value: id: 21 actor_id: 12 @@ -42815,7 +42820,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42841,7 +42846,7 @@ paths: category: orgs subcategory: rules parameters: - - *99 + - *61 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42853,11 +42858,11 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *277 + default: *282 '404': *6 - '500': *100 + '500': *98 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -42873,7 +42878,7 @@ paths: category: orgs subcategory: rules parameters: - - *99 + - *61 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42899,16 +42904,16 @@ paths: - tag - push - repository - enforcement: *253 + enforcement: *258 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *254 - conditions: *255 + items: *259 + conditions: *260 rules: description: An array of rules within the ruleset. type: array - items: *278 + items: *283 examples: default: value: @@ -42943,11 +42948,11 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *277 + default: *282 '404': *6 - '500': *100 + '500': *98 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -42963,7 +42968,7 @@ paths: category: orgs subcategory: rules parameters: - - *99 + - *61 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42974,7 +42979,7 @@ paths: '204': description: Response '404': *6 - '500': *100 + '500': *98 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -42986,7 +42991,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *99 + - *61 - *17 - *19 - name: ruleset_id @@ -43002,7 +43007,7 @@ paths: application/json: schema: type: array - items: &279 + items: &284 title: Ruleset version type: object description: The historical version of a ruleset @@ -43026,7 +43031,7 @@ paths: type: string format: date-time examples: - default: &579 + default: &576 value: - version_id: 3 actor: @@ -43044,7 +43049,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43061,7 +43066,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *99 + - *61 - name: ruleset_id description: The ID of the ruleset. in: path @@ -43079,9 +43084,9 @@ paths: description: Response content: application/json: - schema: &580 + schema: &577 allOf: - - *279 + - *284 - type: object required: - state @@ -43128,7 +43133,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43150,15 +43155,53 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *99 - - *280 - - *281 - - *282 - - *283 + - *61 + - &578 + 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 + - &579 + 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 + - &580 + 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 + - &581 + 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 - *46 - *19 - *17 - - &581 + - &582 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 @@ -43168,7 +43211,7 @@ paths: required: false schema: type: string - - &582 + - &583 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 @@ -43178,10 +43221,42 @@ paths: required: false schema: type: string - - *284 - - *285 - - *286 - - *287 + - &584 + 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 + - &585 + 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 + - &586 + 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 + - &587 + 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 @@ -43189,13 +43264,615 @@ paths: application/json: schema: type: array - items: *288 + items: + type: object + properties: + number: *151 + created_at: *152 + updated_at: + anyOf: + - type: 'null' + - *153 + url: *154 + html_url: *155 + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this + alert. + state: &588 + 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: &589 + type: + - string + - 'null' + description: "**Required when the `state` is `resolved`.** The + reason for resolving the alert." + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + - + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - *4 + 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: *51 + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected + secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - *4 + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in + ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection + bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + resolution_comment: + type: + - string + - 'null' + description: The comment that was optionally added when this + alert was closed + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: + - boolean + - 'null' + description: Whether the secret was publicly leaked. + multi_repo: + type: + - boolean + - 'null' + description: Whether the detected secret was found in multiple + repositories in the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert + is base64 encoded + first_location_detected: + anyOf: + - type: 'null' + - &590 + description: 'Details on the location where the token was + initially detected. This can be a commit, wiki commit, issue, + discussion, pull request. + + ' + oneOf: + - &592 + 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 + examples: + - "/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 + examples: + - 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 + examples: + - 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 + - &593 + 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 + examples: + - "/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 + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki + page + examples: + - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + examples: + - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki + commit + examples: + - 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 + - &594 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + - &595 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + - &596 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + - &597 + 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. + examples: + - https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + - &598 + 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. + examples: + - https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + - &599 + 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. + examples: + - https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + - &600 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + - &601 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + - &602 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + - &603 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + - &604 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + 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: + anyOf: + - type: 'null' + - *4 examples: - default: *289 + 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: *57 + Link: *52 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43220,7 +43897,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *99 + - *61 responses: '200': description: Response @@ -43232,7 +43909,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &291 + pattern_config_version: &286 type: - string - 'null' @@ -43242,7 +43919,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &290 + items: &285 type: object properties: token_type: @@ -43311,7 +43988,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *290 + items: *285 examples: default: value: @@ -43360,7 +44037,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *99 + - *61 requestBody: required: true content: @@ -43368,7 +44045,7 @@ paths: schema: type: object properties: - pattern_config_version: *291 + pattern_config_version: *286 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -43394,7 +44071,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *291 + custom_pattern_version: *286 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -43448,7 +44125,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *99 + - *61 - *46 - name: sort description: The property to sort the results by. @@ -43492,7 +44169,7 @@ paths: application/json: schema: type: array - items: &603 + items: &608 description: A repository security advisory. type: object properties: @@ -43736,7 +44413,7 @@ paths: login: type: string description: The username of the user credited. - type: *292 + type: *287 credits_detailed: type: - array @@ -43747,7 +44424,7 @@ paths: type: object properties: user: *4 - type: *292 + type: *287 state: type: string description: The state of the user's acceptance of the @@ -43773,7 +44450,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *161 + items: *169 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -43811,7 +44488,7 @@ paths: - private_fork additionalProperties: false examples: - default: &604 + default: &609 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -44190,7 +44867,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *99 + - *61 responses: '200': description: Response @@ -44198,9 +44875,9 @@ paths: application/json: schema: type: array - items: *214 + items: *220 examples: - default: *215 + default: *221 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44223,8 +44900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *99 - - *64 + - *61 + - *62 responses: '204': description: Response @@ -44249,8 +44926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *99 - - *64 + - *61 + - *62 responses: '204': description: Response @@ -44279,13 +44956,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &669 + schema: &673 type: object properties: total_minutes_used: @@ -44355,7 +45032,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &670 + default: &674 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -44385,13 +45062,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &671 + schema: &675 type: object properties: total_gigabytes_bandwidth_used: @@ -44409,7 +45086,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &672 + default: &676 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -44435,13 +45112,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: &676 + schema: &680 type: object properties: days_left_in_billing_cycle: @@ -44459,7 +45136,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &677 + default: &681 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -44483,7 +45160,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *99 + - *61 responses: '200': description: Immutable releases settings response @@ -44533,7 +45210,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *99 + - *61 responses: '204': description: Response @@ -44591,7 +45268,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *99 + - *61 - *19 - *17 responses: @@ -44609,9 +45286,9 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: *143 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44630,7 +45307,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *99 + - *61 requestBody: required: true content: @@ -44679,8 +45356,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: - - *99 - - *120 + - *61 + - *124 responses: '204': description: Response @@ -44702,8 +45379,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: - - *99 - - *120 + - *61 + - *124 responses: '204': description: Response @@ -44726,7 +45403,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *99 + - *61 - *17 - *19 responses: @@ -44744,7 +45421,7 @@ paths: type: integer network_configurations: type: array - items: &293 + items: &288 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -44808,7 +45485,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44827,7 +45504,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: - - *99 + - *61 requestBody: required: true content: @@ -44869,9 +45546,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *288 examples: - default: &294 + default: &289 value: id: 123456789ABCDEF name: My network configuration @@ -44899,8 +45576,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: - - *99 - - &295 + - *61 + - &290 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -44912,11 +45589,11 @@ paths: description: Response content: application/json: - schema: *293 + schema: *288 examples: - default: *294 + default: *289 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44935,8 +45612,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: - - *99 - - *295 + - *61 + - *290 requestBody: required: true content: @@ -44975,9 +45652,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *288 examples: - default: *294 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44996,8 +45673,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: - - *99 - - *295 + - *61 + - *290 responses: '204': description: Response @@ -45020,7 +45697,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: - - *99 + - *61 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -45079,7 +45756,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: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45109,8 +45786,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *99 - - *64 + - *61 + - *62 - 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`). @@ -45142,13 +45819,13 @@ paths: application/json: schema: type: array - items: *296 + items: *291 examples: - default: *297 - '500': *100 + default: *292 + '500': *98 '403': *27 '404': *6 - '422': *298 + '422': *293 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45166,7 +45843,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *99 + - *61 - *17 - *19 responses: @@ -45176,11 +45853,11 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 headers: - Link: *57 + Link: *52 '403': *27 x-github: githubCloudOnly: false @@ -45200,7 +45877,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *99 + - *61 requestBody: required: true content: @@ -45272,7 +45949,7 @@ paths: description: Response content: application/json: - schema: &299 + schema: &294 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -45346,7 +46023,7 @@ paths: parent: anyOf: - type: 'null' - - *214 + - *220 members_count: type: integer examples: @@ -45671,7 +46348,7 @@ paths: - repos_count - organization examples: - default: &300 + default: &295 value: id: 1 node_id: MDQ6VGVhbTE= @@ -45741,16 +46418,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *99 - - *64 + - *61 + - *62 responses: '200': description: Response content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '404': *6 x-github: githubCloudOnly: false @@ -45771,8 +46448,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *99 - - *64 + - *61 + - *62 requestBody: required: false content: @@ -45835,16 +46512,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '201': description: Response content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '404': *6 '422': *15 '403': *27 @@ -45869,8 +46546,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *99 - - *64 + - *61 + - *62 responses: '204': description: Response @@ -45896,8 +46573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *99 - - *64 + - *61 + - *62 - *46 - *17 - *19 @@ -45914,7 +46591,7 @@ paths: application/json: schema: type: array - items: &301 + items: &296 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -46005,7 +46682,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *70 + reactions: *68 required: - author - body @@ -46025,7 +46702,7 @@ paths: - updated_at - url examples: - default: &621 + default: &626 value: - author: login: octocat @@ -46075,7 +46752,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46099,8 +46776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *99 - - *64 + - *61 + - *62 requestBody: required: true content: @@ -46134,9 +46811,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: &302 + default: &297 value: author: login: octocat @@ -46208,9 +46885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *99 - - *64 - - &303 + - *61 + - *62 + - &298 name: discussion_number description: The number that identifies the discussion. in: path @@ -46222,9 +46899,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: *302 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46246,9 +46923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 requestBody: required: false content: @@ -46271,9 +46948,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: &622 + default: &627 value: author: login: octocat @@ -46343,9 +47020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 responses: '204': description: Response @@ -46371,9 +47048,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 - *46 - *17 - *19 @@ -46384,7 +47061,7 @@ paths: application/json: schema: type: array - items: &304 + items: &299 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -46449,7 +47126,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *70 + reactions: *68 required: - author - body @@ -46464,7 +47141,7 @@ paths: - updated_at - url examples: - default: &623 + default: &628 value: - author: login: octocat @@ -46508,7 +47185,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46532,9 +47209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 requestBody: required: true content: @@ -46556,9 +47233,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: &305 + default: &300 value: author: login: octocat @@ -46624,10 +47301,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *99 - - *64 - - *303 - - &306 + - *61 + - *62 + - *298 + - &301 name: comment_number description: The number that identifies the comment. in: path @@ -46639,9 +47316,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: *305 + default: *300 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46663,10 +47340,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *99 - - *64 - - *303 - - *306 + - *61 + - *62 + - *298 + - *301 requestBody: required: true content: @@ -46688,9 +47365,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: &624 + default: &629 value: author: login: octocat @@ -46754,10 +47431,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *99 - - *64 - - *303 - - *306 + - *61 + - *62 + - *298 + - *301 responses: '204': description: Response @@ -46783,10 +47460,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *99 - - *64 - - *303 - - *306 + - *61 + - *62 + - *298 + - *301 - 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. @@ -46812,7 +47489,7 @@ paths: application/json: schema: type: array - items: &307 + items: &302 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -46856,7 +47533,7 @@ paths: - content - created_at examples: - default: &309 + default: &304 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -46882,7 +47559,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46906,10 +47583,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *99 - - *64 - - *303 - - *306 + - *61 + - *62 + - *298 + - *301 requestBody: required: true content: @@ -46942,9 +47619,9 @@ paths: team discussion comment content: application/json: - schema: *307 + schema: *302 examples: - default: &308 + default: &303 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -46973,9 +47650,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46998,11 +47675,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *99 - - *64 - - *303 - - *306 - - &310 + - *61 + - *62 + - *298 + - *301 + - &305 name: reaction_id description: The unique identifier of the reaction. in: path @@ -47034,9 +47711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 - 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. @@ -47062,11 +47739,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47090,9 +47767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *99 - - *64 - - *303 + - *61 + - *62 + - *298 requestBody: required: true content: @@ -47124,16 +47801,16 @@ paths: description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47156,10 +47833,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *99 - - *64 - - *303 - - *310 + - *61 + - *62 + - *298 + - *305 responses: '204': description: Response @@ -47183,8 +47860,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *99 - - *64 + - *61 + - *62 - *17 - *19 responses: @@ -47194,11 +47871,11 @@ paths: application/json: schema: type: array - items: *196 + items: *202 examples: - default: *197 + default: *203 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47218,8 +47895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *99 - - *64 + - *61 + - *62 - name: role description: Filters members returned by their role in the team. in: query @@ -47242,9 +47919,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47272,15 +47949,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *99 - - *64 + - *61 - *62 + - *57 responses: '200': description: Response content: application/json: - schema: &311 + schema: &306 title: Team Membership description: Team Membership type: object @@ -47308,7 +47985,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &625 + response-if-user-is-a-team-maintainer: &630 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -47344,9 +48021,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *99 - - *64 + - *61 - *62 + - *57 requestBody: required: false content: @@ -47371,9 +48048,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *306 examples: - response-if-users-membership-with-team-is-now-pending: &626 + response-if-users-membership-with-team-is-now-pending: &631 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -47408,9 +48085,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *99 - - *64 + - *61 - *62 + - *57 responses: '204': description: Response @@ -47435,8 +48112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *99 - - *64 + - *61 + - *62 - *17 - *19 responses: @@ -47446,7 +48123,7 @@ paths: application/json: schema: type: array - items: &312 + items: &307 title: Team Project description: A team's access to a project. type: object @@ -47515,7 +48192,7 @@ paths: - updated_at - permissions examples: - default: &627 + default: &632 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -47555,7 +48232,7 @@ paths: write: true admin: false headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47578,9 +48255,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *99 - - *64 - - &313 + - *61 + - *62 + - &308 name: project_id description: The unique identifier of the project. in: path @@ -47592,9 +48269,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *307 examples: - default: &628 + default: &633 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -47656,9 +48333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *99 - - *64 - - *313 + - *61 + - *62 + - *308 requestBody: required: false content: @@ -47725,9 +48402,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *99 - - *64 - - *313 + - *61 + - *62 + - *308 responses: '204': description: Response @@ -47754,8 +48431,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *99 - - *64 + - *61 + - *62 - *17 - *19 responses: @@ -47765,11 +48442,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47796,16 +48473,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *99 - - *64 - - *314 - - *315 + - *61 + - *62 + - *309 + - *310 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &629 + schema: &634 title: Team Repository description: A team's access to a repository. type: object @@ -47831,7 +48508,7 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 forks: type: integer permissions: @@ -48446,10 +49123,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *99 - - *64 - - *314 - - *315 + - *61 + - *62 + - *309 + - *310 requestBody: required: false content: @@ -48494,10 +49171,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *99 - - *64 - - *314 - - *315 + - *61 + - *62 + - *309 + - *310 responses: '204': description: Response @@ -48521,8 +49198,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *99 - - *64 + - *61 + - *62 - *17 - *19 responses: @@ -48532,9 +49209,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - response-if-child-teams-exist: &630 + response-if-child-teams-exist: &635 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -48562,7 +49239,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48587,7 +49264,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *99 + - *61 - name: security_product in: path description: The security feature to enable or disable. @@ -48661,7 +49338,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column parameters: - - &316 + - &311 name: column_id description: The unique identifier of the column. in: path @@ -48673,7 +49350,7 @@ paths: description: Response content: application/json: - schema: &317 + schema: &312 title: Project Column description: Project columns contain cards of work. type: object @@ -48727,7 +49404,7 @@ paths: - created_at - updated_at examples: - default: &318 + default: &313 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -48762,7 +49439,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column parameters: - - *316 + - *311 requestBody: required: true content: @@ -48787,9 +49464,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: - default: *318 + default: *313 '304': *35 '403': *27 '401': *23 @@ -48814,7 +49491,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column parameters: - - *316 + - *311 responses: '204': description: Response @@ -48843,7 +49520,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column parameters: - - *316 + - *311 requestBody: required: true content: @@ -48904,15 +49581,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#get-a-project parameters: - - *313 + - *308 responses: '200': description: Response content: application/json: - schema: *232 + schema: *238 examples: - default: &319 + default: &314 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -48969,7 +49646,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#update-a-project parameters: - - *313 + - *308 requestBody: required: false content: @@ -49018,9 +49695,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *238 examples: - default: *319 + default: *314 '404': description: Not Found if the authenticated user does not have access to the project @@ -49041,7 +49718,7 @@ paths: items: type: string '401': *23 - '410': *320 + '410': *315 '422': *7 x-github: githubCloudOnly: false @@ -49064,7 +49741,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#delete-a-project parameters: - - *313 + - *308 responses: '204': description: Delete Success @@ -49085,7 +49762,7 @@ paths: items: type: string '401': *23 - '410': *320 + '410': *315 '404': *6 x-github: githubCloudOnly: false @@ -49109,7 +49786,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators parameters: - - *313 + - *308 - 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 @@ -49136,9 +49813,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '404': *6 '422': *15 '304': *35 @@ -49166,8 +49843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator parameters: - - *313 - - *62 + - *308 + - *57 requestBody: required: false content: @@ -49221,8 +49898,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *313 - - *62 + - *308 + - *57 responses: '204': description: Response @@ -49253,8 +49930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *313 - - *62 + - *308 + - *57 responses: '200': description: Response @@ -49324,7 +50001,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#list-project-columns parameters: - - *313 + - *308 - *17 - *19 responses: @@ -49334,7 +50011,7 @@ paths: application/json: schema: type: array - items: *317 + items: *312 examples: default: value: @@ -49347,7 +50024,7 @@ paths: created_at: '2016-09-05T14:18:44Z' updated_at: '2016-09-05T14:22:28Z' headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -49372,7 +50049,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#create-a-project-column parameters: - - *313 + - *308 requestBody: required: true content: @@ -49396,7 +50073,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *312 examples: default: value: @@ -49461,7 +50138,7 @@ paths: resources: type: object properties: - core: &321 + core: &316 title: Rate Limit type: object properties: @@ -49478,21 +50155,21 @@ paths: - remaining - reset - used - graphql: *321 - search: *321 - code_search: *321 - source_import: *321 - integration_manifest: *321 - code_scanning_upload: *321 - actions_runner_registration: *321 - scim: *321 - dependency_snapshots: *321 - dependency_sbom: *321 - code_scanning_autofix: *321 + graphql: *316 + search: *316 + code_search: *316 + source_import: *316 + integration_manifest: *316 + code_scanning_upload: *316 + actions_runner_registration: *316 + scim: *316 + dependency_snapshots: *316 + dependency_sbom: *316 + code_scanning_autofix: *316 required: - core - search - rate: *321 + rate: *316 required: - rate - resources @@ -49597,14 +50274,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *322 + schema: *317 examples: default-response: summary: Default response @@ -50105,7 +50782,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *323 + '301': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50123,8 +50800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -50372,10 +51049,10 @@ paths: description: Response content: application/json: - schema: *322 + schema: *317 examples: - default: *324 - '307': &325 + default: *319 + '307': &320 description: Temporary Redirect content: application/json: @@ -50404,8 +51081,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -50427,7 +51104,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *325 + '307': *320 '404': *6 '409': *45 x-github: @@ -50451,11 +51128,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 - - &356 + - &351 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50478,7 +51155,7 @@ paths: type: integer artifacts: type: array - items: &326 + items: &321 title: Artifact description: An artifact type: object @@ -50573,7 +51250,7 @@ paths: - expires_at - updated_at examples: - default: &357 + default: &352 value: total_count: 2 artifacts: @@ -50612,7 +51289,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50634,9 +51311,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *314 - - *315 - - &327 + - *309 + - *310 + - &322 name: artifact_id description: The unique identifier of the artifact. in: path @@ -50648,7 +51325,7 @@ paths: description: Response content: application/json: - schema: *326 + schema: *321 examples: default: value: @@ -50686,9 +51363,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *314 - - *315 - - *327 + - *309 + - *310 + - *322 responses: '204': description: Response @@ -50712,9 +51389,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *314 - - *315 - - *327 + - *309 + - *310 + - *322 - name: archive_format in: path required: true @@ -50728,7 +51405,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': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50751,14 +51428,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *328 + schema: *323 examples: default: value: @@ -50784,11 +51461,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 - - &329 + - &324 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 @@ -50822,7 +51499,7 @@ paths: description: Response content: application/json: - schema: &330 + schema: &325 title: Repository actions caches description: Repository actions caches type: object @@ -50872,7 +51549,7 @@ paths: - total_count - actions_caches examples: - default: &331 + default: &326 value: total_count: 1 actions_caches: @@ -50884,7 +51561,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50904,23 +51581,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: - - *314 - - *315 + - *309 + - *310 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *329 + - *324 responses: '200': description: Response content: application/json: - schema: *330 + schema: *325 examples: - default: *331 + default: *326 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50940,8 +51617,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: - - *314 - - *315 + - *309 + - *310 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -50972,9 +51649,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *314 - - *315 - - &332 + - *309 + - *310 + - &327 name: job_id description: The unique identifier of the job. in: path @@ -50986,7 +51663,7 @@ paths: description: Response content: application/json: - schema: &360 + schema: &355 title: Job description: Information of a job execution in a workflow run type: object @@ -51333,9 +52010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *314 - - *315 - - *332 + - *309 + - *310 + - *327 responses: '302': description: Response @@ -51363,9 +52040,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *314 - - *315 - - *332 + - *309 + - *310 + - *327 requestBody: required: false content: @@ -51387,7 +52064,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -51411,8 +52088,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Status response @@ -51462,8 +52139,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -51497,7 +52174,7 @@ paths: description: Empty response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -51526,8 +52203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -51545,7 +52222,7 @@ paths: type: integer secrets: type: array - items: &362 + items: &357 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -51566,7 +52243,7 @@ paths: - created_at - updated_at examples: - default: &363 + default: &358 value: total_count: 2 secrets: @@ -51577,7 +52254,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51599,9 +52276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *314 - - *315 - - *333 + - *309 + - *310 + - *328 - *19 responses: '200': @@ -51618,7 +52295,7 @@ paths: type: integer variables: type: array - items: &366 + items: &361 title: Actions Variable type: object properties: @@ -51652,7 +52329,7 @@ paths: - created_at - updated_at examples: - default: &367 + default: &362 value: total_count: 2 variables: @@ -51665,7 +52342,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51685,8 +52362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -51695,12 +52372,12 @@ paths: schema: type: object properties: - enabled: &335 + enabled: &330 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *116 - selected_actions_url: *334 - sha_pinning_required: *117 + allowed_actions: *120 + selected_actions_url: *329 + sha_pinning_required: *121 required: - enabled examples: @@ -51728,8 +52405,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -51740,9 +52417,9 @@ paths: schema: type: object properties: - enabled: *335 - allowed_actions: *116 - sha_pinning_required: *117 + enabled: *330 + allowed_actions: *120 + sha_pinning_required: *121 required: - enabled examples: @@ -51772,14 +52449,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &336 + schema: &331 type: object properties: access_level: @@ -51796,7 +52473,7 @@ paths: required: - access_level examples: - default: &337 + default: &332 value: access_level: organization x-github: @@ -51820,15 +52497,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: application/json: - schema: *336 + schema: *331 examples: - default: *337 + default: *332 responses: '204': description: Response @@ -51852,14 +52529,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *338 + schema: *333 examples: default: value: @@ -51883,8 +52560,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Empty response for successful settings update @@ -51894,7 +52571,7 @@ paths: required: true content: application/json: - schema: *339 + schema: *334 examples: default: summary: Set retention days @@ -51918,16 +52595,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *118 + schema: *122 examples: - default: *340 + default: *335 '404': *6 x-github: enabledForGitHubApps: true @@ -51946,8 +52623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -51957,7 +52634,7 @@ paths: required: true content: application/json: - schema: *118 + schema: *122 examples: default: summary: Set approval policy to first time contributors @@ -51981,16 +52658,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *341 + schema: *336 examples: - default: *119 + default: *123 '403': *27 '404': *6 x-github: @@ -52010,15 +52687,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: application/json: - schema: *342 + schema: *337 examples: - default: *119 + default: *123 responses: '204': description: Empty response for successful settings update @@ -52042,16 +52719,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *121 + schema: *125 examples: - default: *122 + default: *126 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52070,8 +52747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -52079,9 +52756,9 @@ paths: required: false content: application/json: - schema: *121 + schema: *125 examples: - selected_actions: *122 + selected_actions: *126 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52103,16 +52780,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *343 + schema: *338 examples: - default: *126 + default: *130 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52133,8 +52810,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Success response @@ -52145,9 +52822,9 @@ paths: required: true content: application/json: - schema: *344 + schema: *339 examples: - default: *126 + default: *130 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52174,8 +52851,8 @@ paths: in: query schema: type: string - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -52193,11 +52870,11 @@ paths: type: integer runners: type: array - items: *133 + items: *137 examples: - default: *134 + default: *138 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52219,8 +52896,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -52228,9 +52905,9 @@ paths: application/json: schema: type: array - items: *345 + items: *340 examples: - default: *346 + default: *341 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52252,8 +52929,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -52296,7 +52973,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *347 + '201': *342 '404': *6 '422': *7 '409': *45 @@ -52327,16 +53004,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '201': description: Response content: application/json: - schema: *135 + schema: *139 examples: - default: *348 + default: *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52364,16 +53041,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '201': description: Response content: application/json: - schema: *135 + schema: *139 examples: - default: *349 + default: *344 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52395,17 +53072,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 responses: '200': description: Response content: application/json: - schema: *133 + schema: *137 examples: - default: *350 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52426,9 +53103,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 responses: '204': description: Response @@ -52454,11 +53131,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 responses: - '200': *137 + '200': *141 '404': *6 x-github: githubCloudOnly: false @@ -52480,9 +53157,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 requestBody: required: true content: @@ -52506,7 +53183,7 @@ paths: - gpu - accelerated responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -52530,9 +53207,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 requestBody: required: true content: @@ -52557,7 +53234,7 @@ paths: - gpu - accelerated responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -52581,11 +53258,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: - - *314 - - *315 - - *132 + - *309 + - *310 + - *136 responses: - '200': *351 + '200': *346 '404': *6 x-github: githubCloudOnly: false @@ -52612,12 +53289,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: - - *314 - - *315 - - *132 - - *352 + - *309 + - *310 + - *136 + - *347 responses: - '200': *137 + '200': *141 '404': *6 '422': *7 x-github: @@ -52643,9 +53320,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *314 - - *315 - - &370 + - *309 + - *310 + - &365 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. @@ -52653,7 +53330,7 @@ paths: required: false schema: type: string - - &371 + - &366 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -52661,7 +53338,7 @@ paths: required: false schema: type: string - - &372 + - &367 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -52670,7 +53347,7 @@ paths: required: false schema: type: string - - &373 + - &368 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 @@ -52697,7 +53374,7 @@ paths: - pending - *17 - *19 - - &374 + - &369 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)." @@ -52706,7 +53383,7 @@ paths: schema: type: string format: date-time - - &353 + - &348 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -52715,13 +53392,13 @@ paths: schema: type: boolean default: false - - &375 + - &370 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &376 + - &371 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -52744,7 +53421,7 @@ paths: type: integer workflow_runs: type: array - items: &354 + items: &349 title: Workflow Run description: An invocation of a workflow type: object @@ -52861,7 +53538,7 @@ paths: type: - array - 'null' - items: *72 + items: *70 created_at: type: string format: date-time @@ -52922,7 +53599,7 @@ paths: head_commit: anyOf: - type: 'null' - - &398 + - &393 title: Simple Commit description: A commit. type: object @@ -52996,8 +53673,8 @@ paths: - timestamp - author - committer - repository: *131 - head_repository: *131 + repository: *135 + head_repository: *135 head_repository_id: type: integer examples: @@ -53037,7 +53714,7 @@ paths: - workflow_url - pull_requests examples: - default: &377 + default: &372 value: total_count: 1 workflow_runs: @@ -53251,7 +53928,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: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53273,24 +53950,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *314 - - *315 - - &355 + - *309 + - *310 + - &350 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *353 + - *348 responses: '200': description: Response content: application/json: - schema: *354 + schema: *349 examples: - default: &358 + default: &353 value: id: 30433642 name: Build @@ -53531,9 +54208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '204': description: Response @@ -53556,9 +54233,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '200': description: Response @@ -53686,15 +54363,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: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '201': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -53721,12 +54398,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 - *17 - *19 - - *356 + - *351 responses: '200': description: Response @@ -53742,11 +54419,11 @@ paths: type: integer artifacts: type: array - items: *326 + items: *321 examples: - default: *357 + default: *352 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53768,25 +54445,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *314 - - *315 - - *355 - - &359 + - *309 + - *310 + - *350 + - &354 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *353 + - *348 responses: '200': description: Response content: application/json: - schema: *354 + schema: *349 examples: - default: *358 + default: *353 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53809,10 +54486,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *314 - - *315 - - *355 - - *359 + - *309 + - *310 + - *350 + - *354 - *17 - *19 responses: @@ -53830,9 +54507,9 @@ paths: type: integer jobs: type: array - items: *360 + items: *355 examples: - default: &361 + default: &356 value: total_count: 1 jobs: @@ -53921,7 +54598,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -53945,10 +54622,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *314 - - *315 - - *355 - - *359 + - *309 + - *310 + - *350 + - *354 responses: '302': description: Response @@ -53976,15 +54653,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '202': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -54011,9 +54688,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: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 requestBody: required: true content: @@ -54080,15 +54757,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '202': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -54115,9 +54792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 - 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 @@ -54147,11 +54824,11 @@ paths: type: integer jobs: type: array - items: *360 + items: *355 examples: - default: *361 + default: *356 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54174,9 +54851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '302': description: Response @@ -54203,14 +54880,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '204': description: Response '403': *27 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54232,9 +54909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '200': description: Response @@ -54303,7 +54980,7 @@ paths: items: type: object properties: - type: &472 + type: &467 type: string description: The type of reviewer. enum: @@ -54314,7 +54991,7 @@ paths: reviewer: anyOf: - *4 - - *161 + - *169 required: - environment - wait_timer @@ -54389,9 +55066,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 requestBody: required: true content: @@ -54441,7 +55118,7 @@ paths: application/json: schema: type: array - items: &467 + items: &462 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -54553,7 +55230,7 @@ paths: - created_at - updated_at examples: - default: &468 + default: &463 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -54609,9 +55286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 requestBody: required: false content: @@ -54633,7 +55310,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -54656,9 +55333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 requestBody: required: false content: @@ -54680,7 +55357,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -54712,9 +55389,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *314 - - *315 - - *355 + - *309 + - *310 + - *350 responses: '200': description: Response @@ -54851,8 +55528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -54870,11 +55547,11 @@ paths: type: integer secrets: type: array - items: *362 + items: *357 examples: - default: *363 + default: *358 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54897,16 +55574,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *364 + schema: *359 examples: - default: *365 + default: *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54928,17 +55605,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '200': description: Response content: application/json: - schema: *362 + schema: *357 examples: - default: &485 + default: &480 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -54964,9 +55641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 requestBody: required: true content: @@ -54997,7 +55674,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -55023,9 +55700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '204': description: Response @@ -55050,9 +55727,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *314 - - *315 - - *333 + - *309 + - *310 + - *328 - *19 responses: '200': @@ -55069,11 +55746,11 @@ paths: type: integer variables: type: array - items: *366 + items: *361 examples: - default: *367 + default: *362 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55094,8 +55771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -55122,7 +55799,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -55147,17 +55824,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *314 - - *315 - - *142 + - *309 + - *310 + - *146 responses: '200': description: Response content: application/json: - schema: *366 + schema: *361 examples: - default: &486 + default: &481 value: name: USERNAME value: octocat @@ -55183,9 +55860,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *314 - - *315 - - *142 + - *309 + - *310 + - *146 requestBody: required: true content: @@ -55227,9 +55904,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *314 - - *315 - - *142 + - *309 + - *310 + - *146 responses: '204': description: Response @@ -55254,8 +55931,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -55273,7 +55950,7 @@ paths: type: integer workflows: type: array - items: &368 + items: &363 title: Workflow description: A GitHub Actions workflow type: object @@ -55368,7 +56045,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: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55391,9 +56068,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *314 - - *315 - - &369 + - *309 + - *310 + - &364 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -55408,7 +56085,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *363 examples: default: value: @@ -55441,9 +56118,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *314 - - *315 - - *369 + - *309 + - *310 + - *364 responses: '204': description: Response @@ -55468,9 +56145,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *314 - - *315 - - *369 + - *309 + - *310 + - *364 responses: '204': description: Response @@ -55521,9 +56198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *314 - - *315 - - *369 + - *309 + - *310 + - *364 responses: '204': description: Response @@ -55550,19 +56227,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *314 - - *315 + - *309 + - *310 + - *364 + - *365 + - *366 + - *367 + - *368 + - *17 + - *19 - *369 + - *348 - *370 - *371 - - *372 - - *373 - - *17 - - *19 - - *374 - - *353 - - *375 - - *376 responses: '200': description: Response @@ -55578,11 +56255,11 @@ paths: type: integer workflow_runs: type: array - items: *354 + items: *349 examples: - default: *377 + default: *372 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55612,9 +56289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *314 - - *315 - - *369 + - *309 + - *310 + - *364 responses: '200': description: Response @@ -55675,8 +56352,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *314 - - *315 + - *309 + - *310 - *46 - *17 - *38 @@ -55825,7 +56502,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 '422': *7 x-github: githubCloudOnly: false @@ -55844,8 +56521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -55857,9 +56534,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -55882,8 +56559,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *314 - - *315 + - *309 + - *310 - name: assignee in: path required: true @@ -55919,8 +56596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -56032,8 +56709,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *38 - *39 @@ -56089,7 +56766,7 @@ paths: initiator: type: string examples: - default: *378 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56109,8 +56786,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -56118,7 +56795,7 @@ paths: application/json: schema: type: array - items: &379 + items: &374 title: Autolink reference description: An autolink reference. type: object @@ -56177,8 +56854,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -56217,9 +56894,9 @@ paths: description: response content: application/json: - schema: *379 + schema: *374 examples: - default: &380 + default: &375 value: id: 1 key_prefix: TICKET- @@ -56250,9 +56927,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *314 - - *315 - - &381 + - *309 + - *310 + - &376 name: autolink_id description: The unique identifier of the autolink. in: path @@ -56264,9 +56941,9 @@ paths: description: Response content: application/json: - schema: *379 + schema: *374 examples: - default: *380 + default: *375 '404': *6 x-github: githubCloudOnly: false @@ -56286,9 +56963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *314 - - *315 - - *381 + - *309 + - *310 + - *376 responses: '204': description: Response @@ -56312,8 +56989,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response if Dependabot is enabled @@ -56363,8 +57040,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -56385,8 +57062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -56406,8 +57083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *314 - - *315 + - *309 + - *310 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -56445,7 +57122,7 @@ paths: - url protected: type: boolean - protection: &383 + protection: &378 title: Branch Protection description: Branch Protection type: object @@ -56488,7 +57165,7 @@ paths: required: - contexts - checks - enforce_admins: &386 + enforce_admins: &381 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -56505,7 +57182,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &388 + required_pull_request_reviews: &383 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -56527,7 +57204,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *161 + items: *169 apps: description: The list of apps with review dismissal access. @@ -56559,7 +57236,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *161 + items: *169 apps: description: The list of apps allowed to bypass pull request requirements. @@ -56589,7 +57266,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &385 + restrictions: &380 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -56652,7 +57329,7 @@ paths: type: string teams: type: array - items: *161 + items: *169 apps: type: array items: @@ -56864,7 +57541,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -56882,9 +57559,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *314 - - *315 - - &384 + - *309 + - *310 + - &379 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). @@ -56898,14 +57575,14 @@ paths: description: Response content: application/json: - schema: &394 + schema: &389 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &443 + commit: &438 title: Commit description: Commit type: object @@ -56944,7 +57621,7 @@ paths: author: anyOf: - type: 'null' - - &382 + - &377 title: Git User description: Metaproperties for Git author/committer information. @@ -56965,7 +57642,7 @@ paths: committer: anyOf: - type: 'null' - - *382 + - *377 message: type: string examples: @@ -56989,7 +57666,7 @@ paths: required: - sha - url - verification: &492 + verification: &487 title: Verification type: object properties: @@ -57025,14 +57702,14 @@ paths: author: oneOf: - *4 - - *140 + - *144 type: - 'null' - object committer: oneOf: - *4 - - *140 + - *144 type: - 'null' - object @@ -57069,7 +57746,7 @@ paths: type: integer files: type: array - items: &454 + items: &449 title: Diff Entry description: Diff Entry type: object @@ -57165,7 +57842,7 @@ paths: - self protected: type: boolean - protection: *383 + protection: *378 protection_url: type: string format: uri @@ -57274,7 +57951,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *323 + '301': *318 '404': *6 x-github: githubCloudOnly: false @@ -57296,15 +57973,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *383 + schema: *378 examples: default: value: @@ -57498,9 +58175,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -57760,7 +58437,7 @@ paths: url: type: string format: uri - required_status_checks: &391 + required_status_checks: &386 title: Status Check Policy description: Status Check Policy type: object @@ -57841,7 +58518,7 @@ paths: items: *4 teams: type: array - items: *161 + items: *169 apps: type: array items: *5 @@ -57859,7 +58536,7 @@ paths: items: *4 teams: type: array - items: *161 + items: *169 apps: type: array items: *5 @@ -57919,7 +58596,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *385 + restrictions: *380 required_conversation_resolution: type: object properties: @@ -58031,9 +58708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58058,17 +58735,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *386 + schema: *381 examples: - default: &387 + default: &382 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -58090,17 +58767,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *386 + schema: *381 examples: - default: *387 + default: *382 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58119,9 +58796,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58146,17 +58823,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *388 + schema: *383 examples: - default: &389 + default: &384 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -58252,9 +58929,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -58352,9 +59029,9 @@ paths: description: Response content: application/json: - schema: *388 + schema: *383 examples: - default: *389 + default: *384 '422': *15 x-github: githubCloudOnly: false @@ -58375,9 +59052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58404,17 +59081,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *386 + schema: *381 examples: - default: &390 + default: &385 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -58437,17 +59114,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *386 + schema: *381 examples: - default: *390 + default: *385 '404': *6 x-github: githubCloudOnly: false @@ -58467,9 +59144,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58494,17 +59171,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *391 + schema: *386 examples: - default: &392 + default: &387 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -58530,9 +59207,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -58584,9 +59261,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *386 examples: - default: *392 + default: *387 '404': *6 '422': *15 x-github: @@ -58608,9 +59285,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58634,9 +59311,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response @@ -58670,9 +59347,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -58739,9 +59416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -58805,9 +59482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: content: application/json: @@ -58873,15 +59550,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response content: application/json: - schema: *385 + schema: *380 examples: default: value: @@ -58972,9 +59649,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -58997,9 +59674,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response @@ -59009,7 +59686,7 @@ paths: type: array items: *5 examples: - default: &393 + default: &388 value: - id: 1 slug: octoapp @@ -59066,9 +59743,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59102,7 +59779,7 @@ paths: type: array items: *5 examples: - default: *393 + default: *388 '422': *15 x-github: githubCloudOnly: false @@ -59123,9 +59800,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59159,7 +59836,7 @@ paths: type: array items: *5 examples: - default: *393 + default: *388 '422': *15 x-github: githubCloudOnly: false @@ -59180,9 +59857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59216,7 +59893,7 @@ paths: type: array items: *5 examples: - default: *393 + default: *388 '422': *15 x-github: githubCloudOnly: false @@ -59238,9 +59915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response @@ -59248,9 +59925,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 '404': *6 x-github: githubCloudOnly: false @@ -59270,9 +59947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -59308,9 +59985,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 '422': *15 x-github: githubCloudOnly: false @@ -59331,9 +60008,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: false content: @@ -59369,9 +60046,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 '422': *15 x-github: githubCloudOnly: false @@ -59392,9 +60069,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: content: application/json: @@ -59429,9 +60106,9 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 '422': *15 x-github: githubCloudOnly: false @@ -59453,9 +60130,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 responses: '200': description: Response @@ -59465,7 +60142,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 '404': *6 x-github: githubCloudOnly: false @@ -59489,9 +60166,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59524,7 +60201,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 '422': *15 x-github: githubCloudOnly: false @@ -59549,9 +60226,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59584,7 +60261,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 '422': *15 x-github: githubCloudOnly: false @@ -59609,9 +60286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59644,7 +60321,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 '422': *15 x-github: githubCloudOnly: false @@ -59671,9 +60348,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 requestBody: required: true content: @@ -59695,7 +60372,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *389 examples: default: value: @@ -59811,8 +60488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -60091,7 +60768,7 @@ paths: description: Response content: application/json: - schema: &395 + schema: &390 title: CheckRun description: A check performed on the code of a given code change type: object @@ -60226,8 +60903,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *72 - deployment: &688 + items: *70 + deployment: &692 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -60514,9 +61191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *314 - - *315 - - &396 + - *309 + - *310 + - &391 name: check_run_id description: The unique identifier of the check run. in: path @@ -60528,9 +61205,9 @@ paths: description: Response content: application/json: - schema: *395 + schema: *390 examples: - default: &397 + default: &392 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -60630,9 +61307,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *314 - - *315 - - *396 + - *309 + - *310 + - *391 requestBody: required: true content: @@ -60872,9 +61549,9 @@ paths: description: Response content: application/json: - schema: *395 + schema: *390 examples: - default: *397 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60894,9 +61571,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *314 - - *315 - - *396 + - *309 + - *310 + - *391 - *17 - *19 responses: @@ -60986,7 +61663,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: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61006,15 +61683,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *314 - - *315 - - *396 + - *309 + - *310 + - *391 responses: '201': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -61052,8 +61729,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -61075,7 +61752,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &399 + schema: &394 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -61157,12 +61834,12 @@ paths: type: - array - 'null' - items: *72 + items: *70 app: anyOf: - type: 'null' - *5 - repository: *131 + repository: *135 created_at: type: - string @@ -61173,7 +61850,7 @@ paths: - string - 'null' format: date-time - head_commit: *398 + head_commit: *393 latest_check_runs_count: type: integer check_runs_url: @@ -61201,7 +61878,7 @@ paths: - check_runs_url - pull_requests examples: - default: &400 + default: &395 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -61492,9 +62169,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *399 + schema: *394 examples: - default: *400 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61513,8 +62190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -61575,7 +62252,7 @@ paths: required: - app_id - setting - repository: *131 + repository: *135 examples: default: value: @@ -61823,9 +62500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *314 - - *315 - - &401 + - *309 + - *310 + - &396 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -61837,9 +62514,9 @@ paths: description: Response content: application/json: - schema: *399 + schema: *394 examples: - default: *400 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61862,17 +62539,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *314 - - *315 - - *401 - - &449 + - *309 + - *310 + - *396 + - &444 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &450 + - &445 name: status description: Returns check runs with the specified `status`. in: query @@ -61911,9 +62588,9 @@ paths: type: integer check_runs: type: array - items: *395 + items: *390 examples: - default: &451 + default: &446 value: total_count: 1 check_runs: @@ -61995,7 +62672,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62015,15 +62692,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *314 - - *315 - - *401 + - *309 + - *310 + - *396 responses: '201': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -62050,21 +62727,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *314 - - *315 - - *402 - - *403 + - *309 + - *310 + - *397 + - *398 - *19 - *17 - - &420 + - &415 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: *404 - - &421 + schema: *399 + - &416 name: pr description: The number of the pull request for the results you want to list. in: query @@ -62089,13 +62766,13 @@ paths: be returned. in: query required: false - schema: *405 + schema: *400 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *406 + schema: *401 responses: '200': description: Response @@ -62106,24 +62783,24 @@ paths: items: type: object properties: - number: *52 - created_at: *53 - updated_at: *54 - url: *55 - html_url: *56 - instances_url: *407 - state: *151 - fixed_at: *147 + number: *151 + created_at: *152 + updated_at: *153 + url: *154 + html_url: *155 + instances_url: *402 + state: *160 + fixed_at: *156 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *148 - dismissed_reason: *408 - dismissed_comment: *409 - rule: *410 - tool: *411 - most_recent_instance: *412 + dismissed_at: *157 + dismissed_reason: *403 + dismissed_comment: *404 + rule: *405 + tool: *406 + most_recent_instance: *407 dismissal_approved_by: anyOf: - type: 'null' @@ -62246,14 +62923,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &413 + '403': &408 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62273,9 +62950,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *314 - - *315 - - &414 + - *309 + - *310 + - &409 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -62283,30 +62960,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *52 + schema: *151 responses: '200': description: Response content: application/json: - schema: &415 + schema: &410 type: object properties: - number: *52 - created_at: *53 - updated_at: *54 - url: *55 - html_url: *56 - instances_url: *407 - state: *151 - fixed_at: *147 + number: *151 + created_at: *152 + updated_at: *153 + url: *154 + html_url: *155 + instances_url: *402 + state: *160 + fixed_at: *156 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *148 - dismissed_reason: *408 - dismissed_comment: *409 + dismissed_at: *157 + dismissed_reason: *403 + dismissed_comment: *404 rule: type: object properties: @@ -62368,8 +63045,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *411 - most_recent_instance: *412 + tool: *406 + most_recent_instance: *407 dismissal_approved_by: anyOf: - type: 'null' @@ -62465,9 +63142,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62485,9 +63162,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 requestBody: required: true content: @@ -62502,8 +63179,8 @@ paths: enum: - open - dismissed - dismissed_reason: *408 - dismissed_comment: *409 + dismissed_reason: *403 + dismissed_comment: *404 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -62522,7 +63199,7 @@ paths: description: Response content: application/json: - schema: *415 + schema: *410 examples: default: value: @@ -62598,14 +63275,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &419 + '403': &414 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': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62625,15 +63302,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: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 responses: '200': description: Response content: application/json: - schema: &416 + schema: &411 type: object properties: status: @@ -62660,13 +63337,13 @@ paths: - description - started_at examples: - default: &417 + default: &412 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &418 + '400': &413 description: Bad Request content: application/json: @@ -62677,9 +63354,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': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62702,29 +63379,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: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 responses: '200': description: OK content: application/json: - schema: *416 + schema: *411 examples: - default: *417 + default: *412 '202': description: Accepted content: application/json: - schema: *416 + schema: *411 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *418 + '400': *413 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -62734,7 +63411,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62756,9 +63433,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: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 requestBody: required: false content: @@ -62804,12 +63481,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *418 - '403': *419 + '400': *413 + '403': *414 '404': *6 '422': description: Unprocessable Entity - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62829,13 +63506,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 - *19 - *17 - - *420 - - *421 + - *415 + - *416 responses: '200': description: Response @@ -62843,7 +63520,7 @@ paths: application/json: schema: type: array - items: *412 + items: *407 examples: default: value: @@ -62882,9 +63559,9 @@ paths: end_column: 50 classifications: - source - '403': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62916,25 +63593,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *314 - - *315 - - *402 - - *403 + - *309 + - *310 + - *397 + - *398 - *19 - *17 - - *421 + - *416 - 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: *404 + schema: *399 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &424 + schema: &419 type: string description: An identifier for the upload. examples: @@ -62956,23 +63633,23 @@ paths: application/json: schema: type: array - items: &425 + items: &420 type: object properties: - ref: *404 - commit_sha: &433 + ref: *399 + commit_sha: &428 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: *422 + analysis_key: *417 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *423 + category: *418 error: type: string examples: @@ -62997,8 +63674,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *424 - tool: *411 + sarif_id: *419 + tool: *406 deletable: type: boolean warning: @@ -63060,9 +63737,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63096,8 +63773,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: - - *314 - - *315 + - *309 + - *310 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63110,7 +63787,7 @@ paths: description: Response content: application/json: - schema: *425 + schema: *420 examples: response: summary: application/json response @@ -63164,14 +63841,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *413 + '403': *408 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63251,8 +63928,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: - - *314 - - *315 + - *309 + - *310 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63308,9 +63985,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': *419 + '403': *414 '404': *6 - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63330,8 +64007,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -63339,7 +64016,7 @@ paths: application/json: schema: type: array - items: &426 + items: &421 title: CodeQL Database description: A CodeQL database. type: object @@ -63451,9 +64128,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': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63480,8 +64157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - name: language in: path description: The language of the CodeQL database. @@ -63493,7 +64170,7 @@ paths: description: Response content: application/json: - schema: *426 + schema: *421 examples: default: value: @@ -63525,11 +64202,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': &456 + '302': &451 description: Found - '403': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63549,8 +64226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *314 - - *315 + - *309 + - *310 - name: language in: path description: The language of the CodeQL database. @@ -63560,9 +64237,9 @@ paths: responses: '204': description: Response - '403': *419 + '403': *414 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63588,8 +64265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -63598,7 +64275,7 @@ paths: type: object additionalProperties: false properties: - language: &427 + language: &422 type: string description: The language targeted by the CodeQL query enum: @@ -63677,7 +64354,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &431 + schema: &426 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -63687,7 +64364,7 @@ paths: description: The ID of the variant analysis. controller_repo: *51 actor: *4 - query_language: *427 + query_language: *422 query_pack_url: type: string description: The download url for the query pack. @@ -63735,7 +64412,7 @@ paths: items: type: object properties: - repository: &428 + repository: &423 title: Repository Identifier description: Repository Identifier type: object @@ -63777,7 +64454,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &432 + analysis_status: &427 type: string description: The new status of the CodeQL variant analysis repository task. @@ -63809,7 +64486,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &429 + access_mismatch_repos: &424 type: object properties: repository_count: @@ -63824,7 +64501,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: *428 + items: *423 required: - repository_count - repositories @@ -63847,8 +64524,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *429 - over_limit_repos: *429 + no_codeql_db_repos: *424 + over_limit_repos: *424 required: - access_mismatch_repos - not_found_repos @@ -63864,7 +64541,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &430 + value: &425 summary: Default response value: id: 1 @@ -64016,17 +64693,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *430 + value: *425 repository_lists: summary: Response for a successful variant analysis submission - value: *430 + value: *425 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64047,8 +64724,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: - - *314 - - *315 + - *309 + - *310 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -64060,11 +64737,11 @@ paths: description: Response content: application/json: - schema: *431 + schema: *426 examples: - default: *430 + default: *425 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64085,7 +64762,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: - - *314 + - *309 - name: repo in: path description: The name of the controller repository. @@ -64120,7 +64797,7 @@ paths: type: object properties: repository: *51 - analysis_status: *432 + analysis_status: *427 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -64224,7 +64901,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64245,8 +64922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -64339,9 +65016,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *413 + '403': *408 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64360,8 +65037,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -64430,7 +65107,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -64455,7 +65132,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *419 + '403': *414 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -64469,7 +65146,7 @@ paths: content: application/json: schema: *3 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64526,8 +65203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -64535,7 +65212,7 @@ paths: schema: type: object properties: - commit_sha: *433 + commit_sha: *428 ref: type: string description: |- @@ -64595,7 +65272,7 @@ paths: schema: type: object properties: - id: *424 + id: *419 url: type: string description: The REST API URL for checking the status of the upload. @@ -64609,11 +65286,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': *419 + '403': *414 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64632,8 +65309,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *314 - - *315 + - *309 + - *310 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -64681,10 +65358,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': *413 + '403': *408 '404': description: Not Found if the sarif id does not match any upload - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64706,8 +65383,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -64763,7 +65440,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': *156 + '204': *165 '304': *35 '403': *27 '404': *6 @@ -64788,8 +65465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *314 - - *315 + - *309 + - *310 - 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 @@ -64917,8 +65594,8 @@ paths: parameters: - *17 - *19 - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -64934,7 +65611,7 @@ paths: type: integer codespaces: type: array - items: *204 + items: *210 examples: default: value: @@ -65210,7 +65887,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': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -65232,8 +65909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -65297,22 +65974,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65336,8 +66013,8 @@ paths: parameters: - *17 - *19 - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -65377,7 +66054,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *100 + '500': *98 '400': *14 '401': *23 '403': *27 @@ -65401,8 +66078,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -65439,9 +66116,9 @@ paths: type: integer machines: type: array - items: *435 + items: *430 examples: - default: &637 + default: &642 value: total_count: 2 machines: @@ -65458,7 +66135,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -65481,8 +66158,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *314 - - *315 + - *309 + - *310 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -65569,8 +66246,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: - - *314 - - *315 + - *309 + - *310 - 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 @@ -65618,7 +66295,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65639,8 +66316,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -65658,7 +66335,7 @@ paths: type: integer secrets: type: array - items: &439 + items: &434 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -65679,9 +66356,9 @@ paths: - created_at - updated_at examples: - default: *436 + default: *431 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65702,16 +66379,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *437 + schema: *432 examples: - default: *438 + default: *433 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65731,17 +66408,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '200': description: Response content: application/json: - schema: *439 + schema: *434 examples: - default: *440 + default: *435 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65761,9 +66438,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 requestBody: required: true content: @@ -65791,7 +66468,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -65815,9 +66492,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '204': description: Response @@ -65845,8 +66522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *314 - - *315 + - *309 + - *310 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -65884,7 +66561,7 @@ paths: application/json: schema: type: array - items: &441 + items: &436 title: Collaborator description: Collaborator type: object @@ -66052,7 +66729,7 @@ paths: admin: false role_name: write headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -66077,9 +66754,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *314 - - *315 - - *62 + - *309 + - *310 + - *57 responses: '204': description: Response if user is a collaborator @@ -66125,9 +66802,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *314 - - *315 - - *62 + - *309 + - *310 + - *57 requestBody: required: false content: @@ -66153,7 +66830,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &505 + schema: &500 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -66165,7 +66842,7 @@ paths: format: int64 examples: - 42 - repository: *131 + repository: *135 invitee: anyOf: - type: 'null' @@ -66341,7 +67018,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *105 + schema: *104 '403': *27 x-github: triggersNotification: true @@ -66381,9 +67058,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *314 - - *315 - - *62 + - *309 + - *310 + - *57 responses: '204': description: No Content when collaborator was removed from the repository. @@ -66414,9 +67091,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *314 - - *315 - - *62 + - *309 + - *310 + - *57 responses: '200': description: if user has admin permissions @@ -66436,7 +67113,7 @@ paths: user: anyOf: - type: 'null' - - *441 + - *436 required: - permission - role_name @@ -66490,8 +67167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -66501,7 +67178,7 @@ paths: application/json: schema: type: array - items: &442 + items: &437 title: Commit Comment description: Commit Comment type: object @@ -66542,8 +67219,8 @@ paths: updated_at: type: string format: date-time - author_association: *69 - reactions: *70 + author_association: *67 + reactions: *68 required: - url - html_url @@ -66559,7 +67236,7 @@ paths: - created_at - updated_at examples: - default: &445 + default: &440 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66593,7 +67270,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66618,17 +67295,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '200': description: Response content: application/json: - schema: *442 + schema: *437 examples: - default: &446 + default: &441 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66685,9 +67362,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -66709,7 +67386,7 @@ paths: description: Response content: application/json: - schema: *442 + schema: *437 examples: default: value: @@ -66760,9 +67437,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '204': description: Response @@ -66783,9 +67460,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 - 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. @@ -66811,11 +67488,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -66834,9 +67511,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -66868,16 +67545,16 @@ paths: description: Reaction exists content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Reaction created content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -66899,10 +67576,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *314 - - *315 - - *84 + - *309 - *310 + - *81 + - *305 responses: '204': description: Response @@ -66951,8 +67628,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *314 - - *315 + - *309 + - *310 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -67008,9 +67685,9 @@ paths: application/json: schema: type: array - items: *443 + items: *438 examples: - default: &551 + default: &548 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67080,8 +67757,8 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *57 - '500': *100 + Link: *52 + '500': *98 '400': *14 '404': *6 '409': *45 @@ -67104,9 +67781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *314 - - *315 - - &444 + - *309 + - *310 + - &439 name: commit_sha description: The SHA of the commit. in: path @@ -67178,9 +67855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *314 - - *315 - - *444 + - *309 + - *310 + - *439 - *17 - *19 responses: @@ -67190,11 +67867,11 @@ paths: application/json: schema: type: array - items: *442 + items: *437 examples: - default: *445 + default: *440 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67220,9 +67897,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *314 - - *315 - - *444 + - *309 + - *310 + - *439 requestBody: required: true content: @@ -67257,9 +67934,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *437 examples: - default: *446 + default: *441 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67287,9 +67964,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *314 - - *315 - - *444 + - *309 + - *310 + - *439 - *17 - *19 responses: @@ -67299,9 +67976,9 @@ paths: application/json: schema: type: array - items: *447 + items: *442 examples: - default: &543 + default: &540 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -67780,7 +68457,7 @@ paths: auto_merge: draft: false headers: - Link: *57 + Link: *52 '409': *45 x-github: githubCloudOnly: false @@ -67838,11 +68515,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *314 - - *315 + - *309 + - *310 - *19 - *17 - - &448 + - &443 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)" @@ -67857,9 +68534,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *438 examples: - default: &531 + default: &526 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67945,8 +68622,8 @@ paths: ..... '422': *15 '404': *6 - '500': *100 - '503': *73 + '500': *98 + '503': *99 '409': *45 x-github: githubCloudOnly: false @@ -67972,11 +68649,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *314 - - *315 - - *448 - - *449 - - *450 + - *309 + - *310 + - *443 + - *444 + - *445 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -68010,11 +68687,11 @@ paths: type: integer check_runs: type: array - items: *395 + items: *390 examples: - default: *451 + default: *446 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68037,9 +68714,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *314 - - *315 - - *448 + - *309 + - *310 + - *443 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -68047,7 +68724,7 @@ paths: schema: type: integer example: 1 - - *449 + - *444 - *17 - *19 responses: @@ -68065,7 +68742,7 @@ paths: type: integer check_suites: type: array - items: *399 + items: *394 examples: default: value: @@ -68240,7 +68917,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: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68265,9 +68942,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *314 - - *315 - - *448 + - *309 + - *310 + - *443 - *17 - *19 responses: @@ -68338,7 +69015,7 @@ paths: type: string total_count: type: integer - repository: *131 + repository: *135 commit_url: type: string format: uri @@ -68469,9 +69146,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *314 - - *315 - - *448 + - *309 + - *310 + - *443 - *17 - *19 responses: @@ -68481,7 +69158,7 @@ paths: application/json: schema: type: array - items: &608 + items: &613 title: Status description: The status of a commit. type: object @@ -68561,8 +69238,8 @@ paths: type: User site_admin: false headers: - Link: *57 - '301': *323 + Link: *52 + '301': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68590,8 +69267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -68624,11 +69301,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *452 + - *447 code_of_conduct_file: anyOf: - type: 'null' - - &453 + - &448 title: Community Health File type: object properties: @@ -68644,23 +69321,23 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 contributing: anyOf: - type: 'null' - - *453 + - *448 readme: anyOf: - type: 'null' - - *453 + - *448 issue_template: anyOf: - type: 'null' - - *453 + - *448 pull_request_template: anyOf: - type: 'null' - - *453 + - *448 required: - code_of_conduct - code_of_conduct_file @@ -68789,8 +69466,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *314 - - *315 + - *309 + - *310 - *19 - *17 - name: basehead @@ -68838,8 +69515,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *443 - merge_base_commit: *443 + base_commit: *438 + merge_base_commit: *438 status: type: string enum: @@ -68863,10 +69540,10 @@ paths: - 6 commits: type: array - items: *443 + items: *438 files: type: array - items: *454 + items: *449 required: - url - html_url @@ -69109,8 +69786,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69152,8 +69829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *314 - - *315 + - *309 + - *310 - name: path description: path parameter in: path @@ -69306,7 +69983,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &455 + response-if-content-is-a-file: &450 summary: Response if content is a file value: type: file @@ -69443,7 +70120,7 @@ paths: - size - type - url - - &556 + - &553 title: Content File description: Content File type: object @@ -69661,7 +70338,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *455 + response-if-content-is-a-file: *450 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -69730,7 +70407,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *456 + '302': *451 '304': *35 x-github: githubCloudOnly: false @@ -69753,8 +70430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *314 - - *315 + - *309 + - *310 - name: path description: path parameter in: path @@ -69849,7 +70526,7 @@ paths: description: Response content: application/json: - schema: &457 + schema: &452 title: File Commit description: File Commit type: object @@ -70005,7 +70682,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *452 examples: example-for-creating-a-file: value: @@ -70059,7 +70736,7 @@ paths: schema: oneOf: - *3 - - &487 + - &482 description: Repository rule violation was detected type: object properties: @@ -70080,7 +70757,7 @@ paths: items: type: object properties: - placeholder_id: &600 + placeholder_id: &605 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -70112,8 +70789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *314 - - *315 + - *309 + - *310 - name: path description: path parameter in: path @@ -70174,7 +70851,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *452 examples: default: value: @@ -70209,7 +70886,7 @@ paths: '422': *15 '404': *6 '409': *45 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70229,8 +70906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *314 - - *315 + - *309 + - *310 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -70331,7 +71008,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *57 + Link: *52 '204': description: Response if repository is empty '403': *27 @@ -70354,31 +71031,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *314 - - *315 - - *162 - - *163 - - *164 - - *165 + - *309 + - *310 + - *170 + - *171 + - *172 + - *173 - 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 - - *166 - - *458 - - *167 - - *168 + - *174 + - *453 + - *175 + - *176 - *46 - - 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)." @@ -70389,8 +71058,6 @@ paths: default: 30 - *38 - *39 - - *169 - - *170 responses: '200': description: Response @@ -70398,11 +71065,11 @@ paths: application/json: schema: type: array - items: &461 + items: &456 type: object description: A Dependabot alert. properties: - number: *52 + number: *151 state: type: string description: The state of the Dependabot alert. @@ -70448,13 +71115,13 @@ paths: - direct - transitive - - security_advisory: *459 + security_advisory: *454 security_vulnerability: *50 - url: *55 - html_url: *56 - created_at: *53 - updated_at: *54 - dismissed_at: *148 + url: *154 + html_url: *155 + created_at: *152 + updated_at: *153 + dismissed_at: *157 dismissed_by: anyOf: - type: 'null' @@ -70478,8 +71145,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *147 - auto_dismissed_at: *460 + fixed_at: *156 + auto_dismissed_at: *455 required: - number - state @@ -70709,9 +71376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *314 - - *315 - - &462 + - *309 + - *310 + - &457 name: alert_number in: path description: |- @@ -70720,13 +71387,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *52 + schema: *151 responses: '200': description: Response content: application/json: - schema: *461 + schema: *456 examples: default: value: @@ -70839,9 +71506,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *314 - - *315 - - *462 + - *309 + - *310 + - *457 requestBody: required: true content: @@ -70886,7 +71553,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *456 examples: default: value: @@ -71015,8 +71682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -71034,7 +71701,7 @@ paths: type: integer secrets: type: array - items: &465 + items: &460 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -71066,7 +71733,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71088,16 +71755,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *463 + schema: *458 examples: - default: *464 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71117,15 +71784,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '200': description: Response content: application/json: - schema: *465 + schema: *460 examples: default: value: @@ -71151,9 +71818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 requestBody: required: true content: @@ -71181,7 +71848,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -71205,9 +71872,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *314 - - *315 - - *139 + - *309 + - *310 + - *143 responses: '204': description: Response @@ -71229,8 +71896,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: - - *314 - - *315 + - *309 + - *310 - 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 @@ -71380,7 +72047,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *57 + Link: *52 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -71404,8 +72071,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -71642,7 +72309,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *57 + Link: *52 '404': *6 '403': *27 x-github: @@ -71665,8 +72332,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -71749,7 +72416,7 @@ paths: - version - url additionalProperties: false - metadata: &466 + metadata: &461 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -71788,7 +72455,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *466 + metadata: *461 resolved: type: object description: A collection of resolved package dependencies. @@ -71802,7 +72469,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *466 + metadata: *461 relationship: type: string description: A notation of whether a dependency is requested @@ -71935,8 +72602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *314 - - *315 + - *309 + - *310 - name: sha description: The SHA recorded at creation time. in: query @@ -71977,11 +72644,11 @@ paths: application/json: schema: type: array - items: *467 + items: *462 examples: - default: *468 + default: *463 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72045,8 +72712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -72128,7 +72795,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *462 examples: simple-example: summary: Simple example @@ -72201,9 +72868,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *314 - - *315 - - &469 + - *309 + - *310 + - &464 name: deployment_id description: deployment_id parameter in: path @@ -72215,7 +72882,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *462 examples: default: value: @@ -72280,9 +72947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *314 - - *315 - - *469 + - *309 + - *310 + - *464 responses: '204': description: Response @@ -72304,9 +72971,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *314 - - *315 - - *469 + - *309 + - *310 + - *464 - *17 - *19 responses: @@ -72316,7 +72983,7 @@ paths: application/json: schema: type: array - items: &470 + items: &465 title: Deployment Status description: The status of a deployment. type: object @@ -72460,7 +73127,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -72480,9 +73147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *314 - - *315 - - *469 + - *309 + - *310 + - *464 requestBody: required: true content: @@ -72557,9 +73224,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *465 examples: - default: &471 + default: &466 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -72615,9 +73282,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *314 - - *315 - - *469 + - *309 + - *310 + - *464 - name: status_id in: path required: true @@ -72628,9 +73295,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *465 examples: - default: *471 + default: *466 '404': *6 x-github: githubCloudOnly: false @@ -72655,8 +73322,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -72713,8 +73380,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -72732,7 +73399,7 @@ paths: - 5 environments: type: array - items: &473 + items: &468 title: Environment description: Details of a deployment environment type: object @@ -72794,7 +73461,7 @@ paths: type: string examples: - wait_timer - wait_timer: &475 + wait_timer: &470 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -72836,11 +73503,11 @@ paths: items: type: object properties: - type: *472 + type: *467 reviewer: anyOf: - *4 - - *161 + - *169 required: - id - node_id @@ -72863,7 +73530,7 @@ paths: - id - node_id - type - deployment_branch_policy: &476 + deployment_branch_policy: &471 type: - object - 'null' @@ -72980,9 +73647,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *314 - - *315 - - &474 + - *309 + - *310 + - &469 name: environment_name in: path required: true @@ -72995,9 +73662,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *468 examples: - default: &477 + default: &472 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -73081,9 +73748,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 requestBody: required: false content: @@ -73093,7 +73760,7 @@ paths: - object - 'null' properties: - wait_timer: *475 + wait_timer: *470 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -73112,14 +73779,14 @@ paths: items: type: object properties: - type: *472 + type: *467 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *476 + deployment_branch_policy: *471 additionalProperties: false examples: default: @@ -73139,9 +73806,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *468 examples: - default: *477 + default: *472 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -73165,9 +73832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 responses: '204': description: Default response @@ -73192,9 +73859,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 - *17 - *19 responses: @@ -73213,7 +73880,7 @@ paths: - 2 branch_policies: type: array - items: &478 + items: &473 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -73274,9 +73941,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 requestBody: required: true content: @@ -73324,9 +73991,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: - example-wildcard: &479 + example-wildcard: &474 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -73368,10 +74035,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *314 - - *315 - - *474 - - &480 + - *309 + - *310 + - *469 + - &475 name: branch_policy_id in: path required: true @@ -73383,9 +74050,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: - default: *479 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73404,10 +74071,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *314 - - *315 - - *474 - - *480 + - *309 + - *310 + - *469 + - *475 requestBody: required: true content: @@ -73436,9 +74103,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *473 examples: - default: *479 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73457,10 +74124,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *314 - - *315 - - *474 - - *480 + - *309 + - *310 + - *469 + - *475 responses: '204': description: Response @@ -73485,9 +74152,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *474 - - *315 - - *314 + - *469 + - *310 + - *309 responses: '200': description: List of deployment protection rules @@ -73504,7 +74171,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &481 + items: &476 title: Deployment protection rule description: Deployment protection rule type: object @@ -73526,7 +74193,7 @@ paths: for the environment. examples: - true - app: &482 + app: &477 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -73629,9 +74296,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: - - *474 - - *315 - - *314 + - *469 + - *310 + - *309 requestBody: content: application/json: @@ -73652,9 +74319,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *481 + schema: *476 examples: - default: &483 + default: &478 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -73689,9 +74356,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: - - *474 - - *315 - - *314 + - *469 + - *310 + - *309 - *19 - *17 responses: @@ -73711,7 +74378,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *482 + items: *477 examples: default: value: @@ -73746,10 +74413,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *314 - - *315 - - *474 - - &484 + - *309 + - *310 + - *469 + - &479 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -73761,9 +74428,9 @@ paths: description: Response content: application/json: - schema: *481 + schema: *476 examples: - default: *483 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73784,10 +74451,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *474 - - *315 - - *314 - - *484 + - *469 + - *310 + - *309 + - *479 responses: '204': description: Response @@ -73813,9 +74480,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 - *17 - *19 responses: @@ -73833,11 +74500,11 @@ paths: type: integer secrets: type: array - items: *362 + items: *357 examples: - default: *363 + default: *358 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73860,17 +74527,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 responses: '200': description: Response content: application/json: - schema: *364 + schema: *359 examples: - default: *365 + default: *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73892,18 +74559,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *314 - - *315 - - *474 - - *139 + - *309 + - *310 + - *469 + - *143 responses: '200': description: Response content: application/json: - schema: *362 + schema: *357 examples: - default: *485 + default: *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73925,10 +74592,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *314 - - *315 - - *474 - - *139 + - *309 + - *310 + - *469 + - *143 requestBody: required: true content: @@ -73959,7 +74626,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -73985,10 +74652,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *314 - - *315 - - *474 - - *139 + - *309 + - *310 + - *469 + - *143 responses: '204': description: Default response @@ -74013,10 +74680,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *314 - - *315 - - *474 - - *333 + - *309 + - *310 + - *469 + - *328 - *19 responses: '200': @@ -74033,11 +74700,11 @@ paths: type: integer variables: type: array - items: *366 + items: *361 examples: - default: *367 + default: *362 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74058,9 +74725,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *314 - - *315 - - *474 + - *309 + - *310 + - *469 requestBody: required: true content: @@ -74087,7 +74754,7 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -74112,18 +74779,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *314 - - *315 - - *474 - - *142 + - *309 + - *310 + - *469 + - *146 responses: '200': description: Response content: application/json: - schema: *366 + schema: *361 examples: - default: *486 + default: *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74144,10 +74811,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *314 - - *315 - - *142 - - *474 + - *309 + - *310 + - *146 + - *469 requestBody: required: true content: @@ -74189,10 +74856,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *314 - - *315 - - *142 - - *474 + - *309 + - *310 + - *146 + - *469 responses: '204': description: Response @@ -74214,8 +74881,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -74225,7 +74892,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: 200-response: value: @@ -74283,8 +74950,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *314 - - *315 + - *309 + - *310 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -74306,7 +74973,7 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: default: value: @@ -74419,7 +75086,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *57 + Link: *52 '400': *14 x-github: githubCloudOnly: false @@ -74443,8 +75110,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -74477,9 +75144,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *317 examples: - default: *324 + default: *319 '400': *14 '422': *15 '403': *27 @@ -74500,8 +75167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -74560,8 +75227,8 @@ paths: application/json: schema: oneOf: - - *105 - - *487 + - *104 + - *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74586,8 +75253,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *314 - - *315 + - *309 + - *310 - name: file_sha in: path required: true @@ -74687,8 +75354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -74797,7 +75464,7 @@ paths: description: Response content: application/json: - schema: &488 + schema: &483 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -75024,15 +75691,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *314 - - *315 - - *444 + - *309 + - *310 + - *439 responses: '200': description: Response content: application/json: - schema: *488 + schema: *483 examples: default: value: @@ -75088,9 +75755,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *314 - - *315 - - &489 + - *309 + - *310 + - &484 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. @@ -75107,7 +75774,7 @@ paths: application/json: schema: type: array - items: &490 + items: &485 title: Git Reference description: Git references within a repository type: object @@ -75161,7 +75828,7 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *57 + Link: *52 '409': *45 x-github: githubCloudOnly: false @@ -75183,17 +75850,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *314 - - *315 - - *489 + - *309 + - *310 + - *484 responses: '200': description: Response content: application/json: - schema: *490 + schema: *485 examples: - default: &491 + default: &486 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -75222,8 +75889,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -75252,9 +75919,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *485 examples: - default: *491 + default: *486 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -75280,9 +75947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *314 - - *315 - - *489 + - *309 + - *310 + - *484 requestBody: required: true content: @@ -75311,9 +75978,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *485 examples: - default: *491 + default: *486 '422': *15 '409': *45 x-github: @@ -75331,9 +75998,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *314 - - *315 - - *489 + - *309 + - *310 + - *484 responses: '204': description: Response @@ -75388,8 +76055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -75456,7 +76123,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &488 title: Git Tag description: Metadata for a Git tag type: object @@ -75512,7 +76179,7 @@ paths: - sha - type - url - verification: *492 + verification: *487 required: - sha - url @@ -75522,7 +76189,7 @@ paths: - tag - message examples: - default: &494 + default: &489 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -75595,8 +76262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *314 - - *315 + - *309 + - *310 - name: tag_sha in: path required: true @@ -75607,9 +76274,9 @@ paths: description: Response content: application/json: - schema: *493 + schema: *488 examples: - default: *494 + default: *489 '404': *6 '409': *45 x-github: @@ -75633,8 +76300,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -75708,7 +76375,7 @@ paths: description: Response content: application/json: - schema: &495 + schema: &490 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -75810,8 +76477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *314 - - *315 + - *309 + - *310 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -75834,7 +76501,7 @@ paths: description: Response content: application/json: - schema: *495 + schema: *490 examples: default-response: summary: Default response @@ -75893,8 +76560,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -75904,7 +76571,7 @@ paths: application/json: schema: type: array - items: &496 + items: &491 title: Webhook description: Webhooks for repositories. type: object @@ -75967,7 +76634,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &719 + last_response: &723 title: Hook Response type: object properties: @@ -76025,7 +76692,7 @@ paths: status: unused message: headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -76044,8 +76711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -76098,9 +76765,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *491 examples: - default: &497 + default: &492 value: type: Repository id: 12345678 @@ -76148,17 +76815,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 responses: '200': description: Response content: application/json: - schema: *496 + schema: *491 examples: - default: *497 + default: *492 '404': *6 x-github: githubCloudOnly: false @@ -76178,9 +76845,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 requestBody: required: true content: @@ -76225,9 +76892,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *491 examples: - default: *497 + default: *492 '422': *15 '404': *6 x-github: @@ -76248,9 +76915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 responses: '204': description: Response @@ -76274,9 +76941,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 responses: '200': description: Response @@ -76303,9 +76970,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 requestBody: required: false content: @@ -76349,11 +77016,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 - *17 - - *177 + - *183 responses: '200': description: Response @@ -76361,9 +77028,9 @@ paths: application/json: schema: type: array - items: *178 + items: *184 examples: - default: *179 + default: *185 '400': *14 '422': *15 x-github: @@ -76382,18 +77049,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 - *16 responses: '200': description: Response content: application/json: - schema: *180 + schema: *186 examples: - default: *181 + default: *187 '400': *14 '422': *15 x-github: @@ -76412,9 +77079,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 - *16 responses: '202': *37 @@ -76437,9 +77104,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 responses: '204': description: Response @@ -76464,9 +77131,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *314 - - *315 - - *176 + - *309 + - *310 + - *182 responses: '204': description: Response @@ -76489,8 +77156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response if immutable releases are enabled @@ -76538,10 +77205,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *314 - - *315 + - *309 + - *310 responses: - '204': *156 + '204': *165 '409': *45 x-github: githubCloudOnly: false @@ -76559,10 +77226,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *314 - - *315 + - *309 + - *310 responses: - '204': *156 + '204': *165 '409': *45 x-github: githubCloudOnly: false @@ -76617,14 +77284,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &498 + schema: &493 title: Import description: A repository import from an external source. type: object @@ -76731,7 +77398,7 @@ paths: - html_url - authors_url examples: - default: &501 + default: &496 value: vcs: subversion use_lfs: true @@ -76747,7 +77414,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': &499 + '503': &494 description: Unavailable due to service under maintenance. content: application/json: @@ -76776,8 +77443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -76825,7 +77492,7 @@ paths: description: Response content: application/json: - schema: *498 + schema: *493 examples: default: value: @@ -76850,7 +77517,7 @@ paths: type: string '422': *15 '404': *6 - '503': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76878,8 +77545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -76931,7 +77598,7 @@ paths: description: Response content: application/json: - schema: *498 + schema: *493 examples: example-1: summary: Example 1 @@ -76979,7 +77646,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': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77002,12 +77669,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response - '503': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77033,9 +77700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *314 - - *315 - - &659 + - *309 + - *310 + - &663 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -77049,7 +77716,7 @@ paths: application/json: schema: type: array - items: &500 + items: &495 title: Porter Author description: Porter Author type: object @@ -77103,7 +77770,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': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77128,8 +77795,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *314 - - *315 + - *309 + - *310 - name: author_id in: path required: true @@ -77159,7 +77826,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *495 examples: default: value: @@ -77172,7 +77839,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77196,8 +77863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -77238,7 +77905,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77266,8 +77933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -77294,11 +77961,11 @@ paths: description: Response content: application/json: - schema: *498 + schema: *493 examples: - default: *501 + default: *496 '422': *15 - '503': *499 + '503': *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77321,8 +77988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -77330,8 +77997,8 @@ paths: application/json: schema: *20 examples: - default: *502 - '301': *323 + default: *497 + '301': *318 '404': *6 x-github: githubCloudOnly: false @@ -77351,8 +78018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -77360,12 +78027,12 @@ paths: application/json: schema: anyOf: - - *194 + - *200 - type: object properties: {} additionalProperties: false examples: - default: &504 + default: &499 value: limit: collaborators_only origin: repository @@ -77390,13 +78057,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: application/json: - schema: *503 + schema: *498 examples: default: summary: Example request body @@ -77408,9 +78075,9 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: - default: *504 + default: *499 '409': description: Response x-github: @@ -77432,8 +78099,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -77456,8 +78123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -77467,9 +78134,9 @@ paths: application/json: schema: type: array - items: *505 + items: *500 examples: - default: &652 + default: &656 value: - id: 1 repository: @@ -77583,7 +78250,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77600,9 +78267,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *314 - - *315 - - *198 + - *309 + - *310 + - *204 requestBody: required: false content: @@ -77631,7 +78298,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *500 examples: default: value: @@ -77762,9 +78429,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *314 - - *315 - - *198 + - *309 + - *310 + - *204 responses: '204': description: Response @@ -77795,8 +78462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *314 - - *315 + - *309 + - *310 - 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 @@ -77844,7 +78511,7 @@ paths: required: false schema: type: string - - *202 + - *208 - name: sort description: What to sort results by. in: query @@ -77857,7 +78524,7 @@ paths: - comments default: created - *46 - - *75 + - *72 - *17 - *19 responses: @@ -77867,9 +78534,9 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: &512 + default: &507 value: - id: 1 node_id: MDU6SXNzdWUx @@ -78016,8 +78683,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *57 - '301': *323 + Link: *52 + '301': *318 '422': *15 '404': *6 x-github: @@ -78046,8 +78713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -78137,9 +78804,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: &509 + default: &504 value: id: 1 node_id: MDU6SXNzdWUx @@ -78293,9 +78960,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *73 + '503': *99 '404': *6 - '410': *320 + '410': *315 x-github: triggersNotification: true githubCloudOnly: false @@ -78323,9 +78990,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *314 - - *315 - - *92 + - *309 + - *310 + - *89 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -78335,7 +79002,7 @@ paths: enum: - asc - desc - - *75 + - *72 - *17 - *19 responses: @@ -78345,9 +79012,9 @@ paths: application/json: schema: type: array - items: *506 + items: *501 examples: - default: &511 + default: &506 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78378,7 +79045,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *57 + Link: *52 '422': *15 '404': *6 x-github: @@ -78405,17 +79072,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '200': description: Response content: application/json: - schema: *506 + schema: *501 examples: - default: &507 + default: &502 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78469,9 +79136,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -78493,9 +79160,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *501 examples: - default: *507 + default: *502 '422': *15 x-github: githubCloudOnly: false @@ -78513,9 +79180,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '204': description: Response @@ -78535,9 +79202,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 - 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. @@ -78563,11 +79230,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -78586,9 +79253,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -78620,16 +79287,16 @@ paths: description: Reaction exists content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Reaction created content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -78651,10 +79318,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *314 - - *315 - - *84 + - *309 - *310 + - *81 + - *305 responses: '204': description: Response @@ -78674,8 +79341,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -78685,7 +79352,7 @@ paths: application/json: schema: type: array - items: &508 + items: &503 title: Issue Event description: Issue Event type: object @@ -78732,7 +79399,7 @@ paths: issue: anyOf: - type: 'null' - - *68 + - *66 label: title: Issue Event Label description: Issue Event Label @@ -78765,7 +79432,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *161 + requested_team: *169 dismissed_review: title: Issue Event Dismissed Review type: object @@ -78832,7 +79499,7 @@ paths: required: - from - to - author_association: *69 + author_association: *67 lock_reason: type: - string @@ -79006,7 +79673,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *57 + Link: *52 '422': *15 x-github: githubCloudOnly: false @@ -79024,8 +79691,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *314 - - *315 + - *309 + - *310 - name: event_id in: path required: true @@ -79036,7 +79703,7 @@ paths: description: Response content: application/json: - schema: *508 + schema: *503 examples: default: value: @@ -79229,7 +79896,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *320 + '410': *315 '403': *27 x-github: githubCloudOnly: false @@ -79263,9 +79930,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *314 - - *315 - - &510 + - *309 + - *310 + - &505 name: issue_number description: The number that identifies the issue. in: path @@ -79277,12 +79944,12 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 - '301': *323 + default: *504 + '301': *318 '404': *6 - '410': *320 + '410': *315 '304': *35 x-github: githubCloudOnly: false @@ -79307,9 +79974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: false content: @@ -79428,15 +80095,15 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 '422': *15 - '503': *73 + '503': *99 '403': *27 - '301': *323 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79454,9 +80121,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: false content: @@ -79482,9 +80149,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79500,9 +80167,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: content: application/json: @@ -79527,9 +80194,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79551,9 +80218,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: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - name: assignee in: path required: true @@ -79593,10 +80260,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *314 - - *315 - - *510 - - *75 + - *309 + - *310 + - *505 + - *72 - *17 - *19 responses: @@ -79606,13 +80273,13 @@ paths: application/json: schema: type: array - items: *506 + items: *501 examples: - default: *511 + default: *506 headers: - Link: *57 + Link: *52 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79641,9 +80308,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -79665,16 +80332,16 @@ paths: description: Response content: application/json: - schema: *506 + schema: *501 examples: - default: *507 + default: *502 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *320 + '410': *315 '422': *15 '404': *6 x-github: @@ -79702,9 +80369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -79714,14 +80381,14 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: *512 + default: *507 headers: - Link: *57 - '301': *323 + Link: *52 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79749,9 +80416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -79773,17 +80440,17 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *323 + '301': *318 '403': *27 - '410': *320 + '410': *315 '422': *15 '404': *6 x-github: @@ -79814,9 +80481,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -79828,15 +80495,15 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 - '301': *323 + default: *504 + '301': *318 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *320 + '410': *315 x-github: triggersNotification: true githubCloudOnly: false @@ -79862,9 +80529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -79874,14 +80541,14 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: *512 + default: *507 headers: - Link: *57 - '301': *323 + Link: *52 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79898,9 +80565,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -79914,7 +80581,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &514 + - &509 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -79963,7 +80630,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &515 + - &510 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -80091,7 +80758,7 @@ paths: - performed_via_github_app - assignee - assigner - - &516 + - &511 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -80137,7 +80804,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &517 + - &512 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -80183,7 +80850,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &518 + - &513 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -80232,7 +80899,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &519 + - &514 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -80261,7 +80928,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *161 + requested_team: *169 requested_reviewer: *4 required: - review_requester @@ -80274,7 +80941,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &520 + - &515 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -80303,7 +80970,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *161 + requested_team: *169 requested_reviewer: *4 required: - review_requester @@ -80316,7 +80983,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &521 + - &516 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -80372,7 +81039,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &522 + - &517 title: Locked Issue Event description: Locked Issue Event type: object @@ -80417,7 +81084,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &523 + - &518 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -80478,7 +81145,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &524 + - &519 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -80539,7 +81206,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &525 + - &520 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -80600,7 +81267,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &526 + - &521 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -80692,8 +81359,8 @@ paths: name: label color: red headers: - Link: *57 - '410': *320 + Link: *52 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80710,9 +81377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -80722,9 +81389,9 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: - default: &513 + default: &508 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80741,10 +81408,10 @@ paths: color: a2eeef default: false headers: - Link: *57 - '301': *323 + Link: *52 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80761,9 +81428,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: false content: @@ -80822,12 +81489,12 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: - default: *513 - '301': *323 + default: *508 + '301': *318 '404': *6 - '410': *320 + '410': *315 '422': *15 x-github: githubCloudOnly: false @@ -80844,9 +81511,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: false content: @@ -80906,12 +81573,12 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: - default: *513 - '301': *323 + default: *508 + '301': *318 '404': *6 - '410': *320 + '410': *315 '422': *15 x-github: githubCloudOnly: false @@ -80928,15 +81595,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 responses: '204': description: Response - '301': *323 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80955,9 +81622,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - name: name in: path required: true @@ -80970,7 +81637,7 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: default: value: @@ -80981,9 +81648,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *323 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81003,9 +81670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: false content: @@ -81034,7 +81701,7 @@ paths: '204': description: Response '403': *27 - '410': *320 + '410': *315 '404': *6 '422': *15 x-github: @@ -81052,9 +81719,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 responses: '204': description: Response @@ -81084,20 +81751,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 responses: '200': description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 - '301': *323 + default: *504 + '301': *318 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81114,9 +81781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - 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. @@ -81142,13 +81809,13 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81166,9 +81833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -81200,16 +81867,16 @@ paths: description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -81231,10 +81898,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *314 - - *315 - - *510 + - *309 - *310 + - *505 + - *305 responses: '204': description: Response @@ -81263,9 +81930,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -81287,9 +81954,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -81322,9 +81989,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -81334,13 +82001,13 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: *512 + default: *507 headers: - Link: *57 + Link: *52 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81368,9 +82035,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -81397,16 +82064,16 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *320 + '410': *315 '422': *15 '404': *6 x-github: @@ -81426,9 +82093,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 requestBody: required: true content: @@ -81459,13 +82126,13 @@ paths: description: Response content: application/json: - schema: *68 + schema: *66 examples: - default: *509 + default: *504 '403': *27 '404': *6 '422': *7 - '503': *73 + '503': *99 x-github: triggersNotification: true githubCloudOnly: false @@ -81483,9 +82150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *314 - - *315 - - *510 + - *309 + - *310 + - *505 - *17 - *19 responses: @@ -81500,6 +82167,11 @@ paths: description: Timeline Event type: object anyOf: + - *509 + - *510 + - *511 + - *512 + - *513 - *514 - *515 - *516 @@ -81508,11 +82180,6 @@ paths: - *519 - *520 - *521 - - *522 - - *523 - - *524 - - *525 - - *526 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -81560,12 +82227,12 @@ paths: issue_url: type: string format: uri - author_association: *69 + author_association: *67 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *70 + reactions: *68 required: - event - actor @@ -81596,7 +82263,7 @@ paths: properties: type: type: string - issue: *68 + issue: *66 required: - event - created_at @@ -81818,7 +82485,7 @@ paths: type: string body_text: type: string - author_association: *69 + author_association: *67 required: - event - id @@ -81841,7 +82508,7 @@ paths: type: string comments: type: array - items: &545 + items: &542 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -81946,7 +82613,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *69 + author_association: *67 _links: type: object properties: @@ -82041,7 +82708,7 @@ paths: enum: - line - file - reactions: *70 + reactions: *68 body_html: type: string examples: @@ -82079,7 +82746,7 @@ paths: type: string comments: type: array - items: *442 + items: *437 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -82352,9 +83019,9 @@ paths: type: User site_admin: true headers: - Link: *57 + Link: *52 '404': *6 - '410': *320 + '410': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82371,8 +83038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -82382,7 +83049,7 @@ paths: application/json: schema: type: array - items: &527 + items: &522 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -82434,7 +83101,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82450,8 +83117,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -82487,9 +83154,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *522 examples: - default: &528 + default: &523 value: id: 1 key: ssh-rsa AAA... @@ -82523,9 +83190,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *314 - - *315 - - &529 + - *309 + - *310 + - &524 name: key_id description: The unique identifier of the key. in: path @@ -82537,9 +83204,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *522 examples: - default: *528 + default: *523 '404': *6 x-github: githubCloudOnly: false @@ -82557,9 +83224,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *314 - - *315 - - *529 + - *309 + - *310 + - *524 responses: '204': description: Response @@ -82579,8 +83246,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -82590,11 +83257,11 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: - default: *513 + default: *508 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -82613,8 +83280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -82650,9 +83317,9 @@ paths: description: Response content: application/json: - schema: *67 + schema: *65 examples: - default: &530 + default: &525 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82684,8 +83351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *314 - - *315 + - *309 + - *310 - name: name in: path required: true @@ -82696,9 +83363,9 @@ paths: description: Response content: application/json: - schema: *67 + schema: *65 examples: - default: *530 + default: *525 '404': *6 x-github: githubCloudOnly: false @@ -82715,8 +83382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *314 - - *315 + - *309 + - *310 - name: name in: path required: true @@ -82755,7 +83422,7 @@ paths: description: Response content: application/json: - schema: *67 + schema: *65 examples: default: value: @@ -82781,8 +83448,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *314 - - *315 + - *309 + - *310 - name: name in: path required: true @@ -82808,8 +83475,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -82848,9 +83515,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *314 - - *315 - - *420 + - *309 + - *310 + - *415 responses: '200': description: Response @@ -82916,7 +83583,7 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 required: - _links - git_url @@ -82997,8 +83664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -83063,8 +83730,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -83098,9 +83765,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *443 + schema: *438 examples: - default: *531 + default: *526 '204': description: Response when already merged '404': @@ -83125,8 +83792,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *314 - - *315 + - *309 + - *310 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -83167,7 +83834,7 @@ paths: application/json: schema: type: array - items: *238 + items: *244 examples: default: value: @@ -83206,7 +83873,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -83223,8 +83890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -83264,9 +83931,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *244 examples: - default: &532 + default: &527 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -83325,9 +83992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *314 - - *315 - - &533 + - *309 + - *310 + - &528 name: milestone_number description: The number that identifies the milestone. in: path @@ -83339,9 +84006,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *244 examples: - default: *532 + default: *527 '404': *6 x-github: githubCloudOnly: false @@ -83358,9 +84025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *314 - - *315 - - *533 + - *309 + - *310 + - *528 requestBody: required: false content: @@ -83398,9 +84065,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *244 examples: - default: *532 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83416,9 +84083,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *314 - - *315 - - *533 + - *309 + - *310 + - *528 responses: '204': description: Response @@ -83439,9 +84106,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *314 - - *315 - - *533 + - *309 + - *310 + - *528 - *17 - *19 responses: @@ -83451,11 +84118,11 @@ paths: application/json: schema: type: array - items: *67 + items: *65 examples: - default: *513 + default: *508 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83472,12 +84139,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *314 - - *315 - - *534 - - *535 - - *75 - - *536 + - *309 + - *310 + - *529 + - *530 + - *72 + - *531 - *17 - *19 responses: @@ -83487,11 +84154,11 @@ paths: application/json: schema: type: array - items: *95 + items: *92 examples: - default: *537 + default: *532 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -83513,8 +84180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -83572,14 +84239,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &538 + schema: &533 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -83723,7 +84390,7 @@ paths: - custom_404 - public examples: - default: &539 + default: &534 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -83764,8 +84431,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -83820,9 +84487,9 @@ paths: description: Response content: application/json: - schema: *538 + schema: *533 examples: - default: *539 + default: *534 '422': *15 '409': *45 x-github: @@ -83845,8 +84512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -83946,8 +84613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -83973,8 +84640,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -83984,7 +84651,7 @@ paths: application/json: schema: type: array - items: &540 + items: &535 title: Page Build description: Page Build type: object @@ -84057,7 +84724,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84076,8 +84743,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *314 - - *315 + - *309 + - *310 responses: '201': description: Response @@ -84124,16 +84791,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *540 + schema: *535 examples: - default: &541 + default: &536 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -84181,8 +84848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *314 - - *315 + - *309 + - *310 - name: build_id in: path required: true @@ -84193,9 +84860,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *535 examples: - default: *541 + default: *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84215,8 +84882,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -84324,9 +84991,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *314 - - *315 - - &542 + - *309 + - *310 + - &537 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -84384,11 +85051,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *314 - - *315 - - *542 + - *309 + - *310 + - *537 responses: - '204': *156 + '204': *165 '404': *6 x-github: githubCloudOnly: false @@ -84413,8 +85080,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -84682,7 +85349,7 @@ paths: description: Empty response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -84709,8 +85376,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: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Private vulnerability reporting status @@ -84747,10 +85414,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: - '204': *156 + '204': *165 '422': *14 x-github: githubCloudOnly: false @@ -84769,10 +85436,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: - '204': *156 + '204': *165 '422': *14 x-github: githubCloudOnly: false @@ -84793,8 +85460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects parameters: - - *314 - - *315 + - *309 + - *310 - name: state description: Indicates the state of the projects to return. in: query @@ -84815,7 +85482,7 @@ paths: application/json: schema: type: array - items: *232 + items: *238 examples: default: value: @@ -84851,11 +85518,11 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *57 + Link: *52 '401': *23 '403': *27 '404': *6 - '410': *320 + '410': *315 '422': *7 x-github: githubCloudOnly: false @@ -84878,8 +85545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -84905,13 +85572,13 @@ paths: description: Response content: application/json: - schema: *232 + schema: *238 examples: - default: *319 + default: *314 '401': *23 '403': *27 '404': *6 - '410': *320 + '410': *315 '422': *7 x-github: githubCloudOnly: false @@ -84934,8 +85601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -84943,16 +85610,9 @@ paths: application/json: schema: type: array - items: *249 + items: *97 examples: - default: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *538 '403': *27 '404': *6 x-github: @@ -84974,8 +85634,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -84987,19 +85647,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *249 + items: *97 required: - properties examples: - default: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *539 responses: '204': description: No Content when custom property values are successfully created @@ -85037,8 +85689,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *314 - - *315 + - *309 + - *310 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -85098,11 +85750,11 @@ paths: application/json: schema: type: array - items: *447 + items: *442 examples: - default: *543 + default: *540 headers: - Link: *57 + Link: *52 '304': *35 '422': *15 x-github: @@ -85132,8 +85784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -85200,7 +85852,7 @@ paths: description: Response content: application/json: - schema: &547 + schema: &544 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -85329,7 +85981,7 @@ paths: milestone: anyOf: - type: 'null' - - *238 + - *244 active_lock_reason: type: - string @@ -85384,7 +86036,7 @@ paths: type: - array - 'null' - items: *214 + items: *220 head: type: object properties: @@ -85392,7 +86044,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *64 sha: type: string user: *4 @@ -85409,7 +86061,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *64 sha: type: string user: *4 @@ -85422,14 +86074,14 @@ paths: _links: type: object properties: - comments: *239 - commits: *239 - statuses: *239 - html: *239 - issue: *239 - review_comments: *239 - review_comment: *239 - self: *239 + comments: *245 + commits: *245 + statuses: *245 + html: *245 + issue: *245 + review_comments: *245 + review_comment: *245 + self: *245 required: - comments - commits @@ -85439,8 +86091,8 @@ paths: - review_comments - review_comment - self - author_association: *69 - auto_merge: *544 + author_association: *67 + auto_merge: *541 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -85542,7 +86194,7 @@ paths: - merged_by - review_comments examples: - default: &548 + default: &545 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -86069,8 +86721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *314 - - *315 + - *309 + - *310 - name: sort in: query required: false @@ -86089,7 +86741,7 @@ paths: enum: - asc - desc - - *75 + - *72 - *17 - *19 responses: @@ -86099,9 +86751,9 @@ paths: application/json: schema: type: array - items: *545 + items: *542 examples: - default: &550 + default: &547 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -86153,7 +86805,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86178,17 +86830,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '200': description: Response content: application/json: - schema: *545 + schema: *542 examples: - default: &546 + default: &543 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -86263,9 +86915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -86287,9 +86939,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *542 examples: - default: *546 + default: *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86305,9 +86957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 responses: '204': description: Response @@ -86328,9 +86980,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 - 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. @@ -86356,11 +87008,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -86379,9 +87031,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *314 - - *315 - - *84 + - *309 + - *310 + - *81 requestBody: required: true content: @@ -86413,16 +87065,16 @@ paths: description: Reaction exists content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Reaction created content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -86444,10 +87096,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *314 - - *315 - - *84 + - *309 - *310 + - *81 + - *305 responses: '204': description: Response @@ -86490,9 +87142,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *314 - - *315 - - &549 + - *309 + - *310 + - &546 name: pull_number description: The number that identifies the pull request. in: path @@ -86505,9 +87157,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *547 + schema: *544 examples: - default: *548 + default: *545 '304': *35 '404': *6 '406': @@ -86515,8 +87167,8 @@ paths: content: application/json: schema: *3 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86542,9 +87194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: false content: @@ -86586,9 +87238,9 @@ paths: description: Response content: application/json: - schema: *547 + schema: *544 examples: - default: *548 + default: *545 '422': *15 '403': *27 x-github: @@ -86610,9 +87262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: true content: @@ -86673,21 +87325,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '401': *23 '403': *27 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86713,10 +87365,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *314 - - *315 - - *549 - - *92 + - *309 + - *310 + - *546 + - *89 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -86726,7 +87378,7 @@ paths: enum: - asc - desc - - *75 + - *72 - *17 - *19 responses: @@ -86736,11 +87388,11 @@ paths: application/json: schema: type: array - items: *545 + items: *542 examples: - default: *550 + default: *547 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86771,9 +87423,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: true content: @@ -86879,7 +87531,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *542 examples: example-for-a-multi-line-comment: value: @@ -86967,10 +87619,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *314 - - *315 - - *549 - - *84 + - *309 + - *310 + - *546 + - *81 requestBody: required: true content: @@ -86992,7 +87644,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *542 examples: default: value: @@ -87078,9 +87730,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 - *17 - *19 responses: @@ -87090,11 +87742,11 @@ paths: application/json: schema: type: array - items: *443 + items: *438 examples: - default: *551 + default: *548 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87122,9 +87774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 - *17 - *19 responses: @@ -87134,7 +87786,7 @@ paths: application/json: schema: type: array - items: *454 + items: *449 examples: default: value: @@ -87150,10 +87802,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *57 + Link: *52 '422': *15 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87172,9 +87824,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 responses: '204': description: Response if pull request has been merged @@ -87197,9 +87849,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: false content: @@ -87311,9 +87963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 responses: '200': description: Response @@ -87329,7 +87981,7 @@ paths: items: *4 teams: type: array - items: *161 + items: *169 required: - users - teams @@ -87370,7 +88022,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87388,9 +88040,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: false content: @@ -87427,7 +88079,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *442 examples: default: value: @@ -87963,9 +88615,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: true content: @@ -87999,7 +88651,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *442 examples: default: value: @@ -88504,9 +89156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 - *17 - *19 responses: @@ -88516,7 +89168,7 @@ paths: application/json: schema: type: array - items: &552 + items: &549 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -88590,7 +89242,7 @@ paths: type: string body_text: type: string - author_association: *69 + author_association: *67 required: - id - node_id @@ -88639,7 +89291,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88672,9 +89324,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: false content: @@ -88764,9 +89416,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *549 examples: - default: &554 + default: &551 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88829,10 +89481,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 - - &553 + - *309 + - *310 + - *546 + - &550 name: review_id description: The unique identifier of the review. in: path @@ -88844,9 +89496,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *549 examples: - default: &555 + default: &552 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88905,10 +89557,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 - - *553 + - *309 + - *310 + - *546 + - *550 requestBody: required: true content: @@ -88931,7 +89583,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *549 examples: default: value: @@ -88993,18 +89645,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 - - *553 + - *309 + - *310 + - *546 + - *550 responses: '200': description: Response content: application/json: - schema: *552 + schema: *549 examples: - default: *554 + default: *551 '422': *7 '404': *6 x-github: @@ -89031,10 +89683,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *314 - - *315 - - *549 - - *553 + - *309 + - *310 + - *546 + - *550 - *17 - *19 responses: @@ -89128,13 +89780,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *69 + author_association: *67 _links: type: object properties: - self: *239 - html: *239 - pull_request: *239 + self: *245 + html: *245 + pull_request: *245 required: - self - html @@ -89143,7 +89795,7 @@ paths: type: string body_html: type: string - reactions: *70 + reactions: *68 side: description: The side of the first line of the range for a multi-line comment. @@ -89263,7 +89915,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -89292,10 +89944,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 - - *553 + - *309 + - *310 + - *546 + - *550 requestBody: required: true content: @@ -89324,7 +89976,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *549 examples: default: value: @@ -89387,10 +90039,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *314 - - *315 - - *549 - - *553 + - *309 + - *310 + - *546 + - *550 requestBody: required: true content: @@ -89425,9 +90077,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *549 examples: - default: *555 + default: *552 '404': *6 '422': *7 '403': *27 @@ -89449,9 +90101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *314 - - *315 - - *549 + - *309 + - *310 + - *546 requestBody: required: false content: @@ -89515,8 +90167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *314 - - *315 + - *309 + - *310 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -89529,9 +90181,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *553 examples: - default: &557 + default: &554 value: type: file encoding: base64 @@ -89573,8 +90225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *314 - - *315 + - *309 + - *310 - name: dir description: The alternate path to look for a README file in: path @@ -89594,9 +90246,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *553 examples: - default: *557 + default: *554 '404': *6 '422': *15 x-github: @@ -89618,8 +90270,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -89629,7 +90281,7 @@ paths: application/json: schema: type: array - items: *558 + items: *555 examples: default: value: @@ -89703,7 +90355,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -89723,8 +90375,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -89800,9 +90452,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *555 examples: - default: &562 + default: &559 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -89907,9 +90559,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *314 - - *315 - - &560 + - *309 + - *310 + - &557 name: asset_id description: The unique identifier of the asset. in: path @@ -89921,9 +90573,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *556 examples: - default: &561 + default: &558 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 @@ -89958,7 +90610,7 @@ paths: type: User site_admin: false '404': *6 - '302': *456 + '302': *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89974,9 +90626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *314 - - *315 - - *560 + - *309 + - *310 + - *557 requestBody: required: false content: @@ -90005,9 +90657,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *556 examples: - default: *561 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90023,9 +90675,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *314 - - *315 - - *560 + - *309 + - *310 + - *557 responses: '204': description: Response @@ -90049,8 +90701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -90136,16 +90788,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *558 + schema: *555 examples: - default: *562 + default: *559 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90162,8 +90814,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *314 - - *315 + - *309 + - *310 - name: tag description: tag parameter in: path @@ -90176,9 +90828,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *555 examples: - default: *562 + default: *559 '404': *6 x-github: githubCloudOnly: false @@ -90200,9 +90852,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *314 - - *315 - - &563 + - *309 + - *310 + - &560 name: release_id description: The unique identifier of the release. in: path @@ -90216,9 +90868,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: *558 + schema: *555 examples: - default: *562 + default: *559 '401': description: Unauthorized x-github: @@ -90236,9 +90888,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 requestBody: required: false content: @@ -90302,9 +90954,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *555 examples: - default: *562 + default: *559 '404': description: Not Found if the discussion category name is invalid content: @@ -90325,9 +90977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 responses: '204': description: Response @@ -90347,9 +90999,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 - *17 - *19 responses: @@ -90359,7 +91011,7 @@ paths: application/json: schema: type: array - items: *559 + items: *556 examples: default: value: @@ -90396,7 +91048,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90440,9 +91092,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: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 - name: name in: query required: true @@ -90468,7 +91120,7 @@ paths: description: Response for successful upload content: application/json: - schema: *559 + schema: *556 examples: response-for-successful-upload: value: @@ -90523,9 +91175,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 - 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. @@ -90549,11 +91201,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -90572,9 +91224,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *314 - - *315 - - *563 + - *309 + - *310 + - *560 requestBody: required: true content: @@ -90604,16 +91256,16 @@ paths: description: Reaction exists content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '201': description: Reaction created content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -90635,10 +91287,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *314 - - *315 - - *563 + - *309 - *310 + - *560 + - *305 responses: '204': description: Response @@ -90662,9 +91314,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *314 - - *315 - - *384 + - *309 + - *310 + - *379 - *17 - *19 responses: @@ -90680,8 +91332,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *256 - - &564 + - *261 + - &561 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -90700,69 +91352,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *257 - - *564 - - allOf: - - *258 - - *564 - - allOf: - - *259 - - *564 - - allOf: - - *565 - - *564 - - allOf: - - *260 - - *564 - - allOf: - - *261 - - *564 - allOf: - *262 - - *564 + - *561 - allOf: - *263 - - *564 + - *561 - allOf: - *264 - - *564 + - *561 + - allOf: + - *562 + - *561 - allOf: - *265 - - *564 + - *561 - allOf: - *266 - - *564 + - *561 - allOf: - *267 - - *564 + - *561 - allOf: - *268 - - *564 + - *561 - allOf: - *269 - - *564 + - *561 - allOf: - *270 - - *564 + - *561 - allOf: - *271 - - *564 + - *561 - allOf: - *272 - - *564 + - *561 - allOf: - *273 - - *564 + - *561 - allOf: - *274 - - *564 + - *561 - allOf: - *275 - - *564 + - *561 + - allOf: + - *276 + - *561 + - allOf: + - *277 + - *561 - allOf: - - *566 - - *564 + - *278 + - *561 + - allOf: + - *279 + - *561 + - allOf: + - *280 + - *561 + - allOf: + - *563 + - *561 examples: default: value: @@ -90801,8 +91453,8 @@ paths: category: repos subcategory: rules parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 - name: includes_parents @@ -90813,7 +91465,7 @@ paths: schema: type: boolean default: true - - *567 + - *564 responses: '200': description: Response @@ -90821,7 +91473,7 @@ paths: application/json: schema: type: array - items: *276 + items: *281 examples: default: value: @@ -90852,7 +91504,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *100 + '500': *98 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -90868,8 +91520,8 @@ paths: category: repos subcategory: rules parameters: - - *314 - - *315 + - *309 + - *310 requestBody: description: Request body required: true @@ -90889,16 +91541,16 @@ paths: - tag - push default: branch - enforcement: *253 + enforcement: *258 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *254 - conditions: *251 + items: *259 + conditions: *256 rules: type: array description: An array of rules within the ruleset. - items: *568 + items: *565 required: - name - enforcement @@ -90929,9 +91581,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: &578 + default: &575 value: id: 42 name: super cool ruleset @@ -90964,7 +91616,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *100 + '500': *98 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -90978,12 +91630,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *314 - - *315 + - *309 + - *310 + - *566 + - *567 + - *568 - *569 - - *570 - - *571 - - *572 - *17 - *19 responses: @@ -90991,11 +91643,11 @@ paths: description: Response content: application/json: - schema: *573 + schema: *570 examples: - default: *574 + default: *571 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91014,19 +91666,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *314 - - *315 - - *575 + - *309 + - *310 + - *572 responses: '200': description: Response content: application/json: - schema: *576 + schema: *573 examples: - default: *577 + default: *574 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91052,8 +91704,8 @@ paths: category: repos subcategory: rules parameters: - - *314 - - *315 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91073,11 +91725,11 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *578 + default: *575 '404': *6 - '500': *100 + '500': *98 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -91093,8 +91745,8 @@ paths: category: repos subcategory: rules parameters: - - *314 - - *315 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91119,16 +91771,16 @@ paths: - branch - tag - push - enforcement: *253 + enforcement: *258 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *254 - conditions: *251 + items: *259 + conditions: *256 rules: description: An array of rules within the ruleset. type: array - items: *568 + items: *565 examples: default: value: @@ -91156,11 +91808,11 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *578 + default: *575 '404': *6 - '500': *100 + '500': *98 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -91176,8 +91828,8 @@ paths: category: repos subcategory: rules parameters: - - *314 - - *315 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91188,7 +91840,7 @@ paths: '204': description: Response '404': *6 - '500': *100 + '500': *98 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -91200,8 +91852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 - name: ruleset_id @@ -91217,11 +91869,11 @@ paths: application/json: schema: type: array - items: *279 + items: *284 examples: - default: *579 + default: *576 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91238,8 +91890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *314 - - *315 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91257,7 +91909,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *577 examples: default: value: @@ -91290,7 +91942,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91312,21 +91964,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *314 - - *315 - - *280 - - *281 - - *282 - - *283 + - *309 + - *310 + - *578 + - *579 + - *580 + - *581 - *46 - *19 - *17 - - *581 - *582 - - *284 - - *285 - - *286 - - *287 + - *583 + - *584 + - *585 + - *586 + - *587 responses: '200': description: Response @@ -91334,24 +91986,24 @@ paths: application/json: schema: type: array - items: &586 + items: &591 type: object properties: - number: *52 - created_at: *53 + number: *151 + created_at: *152 updated_at: anyOf: - type: 'null' - - *54 - url: *55 - html_url: *56 + - *153 + url: *154 + html_url: *155 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *583 - resolution: *584 + state: *588 + resolution: *589 resolved_at: type: - string @@ -91445,7 +92097,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *585 + - *590 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -91568,7 +92220,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91590,16 +92242,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *314 - - *315 - - *414 - - *287 + - *309 + - *310 + - *409 + - *587 responses: '200': description: Response content: application/json: - schema: *586 + schema: *591 examples: default: value: @@ -91630,7 +92282,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91651,9 +92303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 requestBody: required: true content: @@ -91661,8 +92313,8 @@ paths: schema: type: object properties: - state: *583 - resolution: *584 + state: *588 + resolution: *589 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -91681,7 +92333,7 @@ paths: description: Response content: application/json: - schema: *586 + schema: *591 examples: default: value: @@ -91734,7 +92386,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -91756,9 +92408,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *314 - - *315 - - *414 + - *309 + - *310 + - *409 - *19 - *17 responses: @@ -91769,7 +92421,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &739 + items: &743 type: object properties: type: @@ -91796,11 +92448,6 @@ paths: - commit details: oneOf: - - *587 - - *588 - - *589 - - *590 - - *591 - *592 - *593 - *594 @@ -91809,6 +92456,11 @@ paths: - *597 - *598 - *599 + - *600 + - *601 + - *602 + - *603 + - *604 examples: default: value: @@ -91868,11 +92520,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *57 + Link: *52 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91894,8 +92546,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -91903,14 +92555,14 @@ paths: schema: type: object properties: - reason: &601 + reason: &606 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *600 + placeholder_id: *605 required: - reason - placeholder_id @@ -91927,7 +92579,7 @@ paths: schema: type: object properties: - reason: *601 + reason: *606 expire_at: type: - string @@ -91951,7 +92603,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *73 + '503': *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -91963,6 +92615,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 @@ -91971,13 +92626,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: - - *314 - - *315 + - *309 + - *310 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *73 + '503': *99 '200': description: Response content: @@ -91987,7 +92642,7 @@ paths: properties: incremental_scans: type: array - items: &602 + items: &607 description: Information on a single scan performed by secret scanning on the repository type: object @@ -92015,15 +92670,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *602 + items: *607 backfill_scans: type: array - items: *602 + items: *607 custom_pattern_backfill_scans: type: array items: allOf: - - *602 + - *607 - type: object properties: pattern_name: @@ -92093,8 +92748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *314 - - *315 + - *309 + - *310 - *46 - name: sort description: The property to sort the results by. @@ -92138,9 +92793,9 @@ paths: application/json: schema: type: array - items: *603 + items: *608 examples: - default: *604 + default: *609 '400': *14 '404': *6 x-github: @@ -92163,8 +92818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -92244,7 +92899,7 @@ paths: login: type: string description: The username of the user credited. - type: *292 + type: *287 required: - login - type @@ -92334,9 +92989,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *608 examples: - default: &606 + default: &611 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -92569,8 +93224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -92683,7 +93338,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *608 examples: default: value: @@ -92830,17 +93485,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *314 - - *315 - - *605 + - *309 + - *310 + - *610 responses: '200': description: Response content: application/json: - schema: *603 + schema: *608 examples: - default: *606 + default: *611 '403': *27 '404': *6 x-github: @@ -92864,9 +93519,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *314 - - *315 - - *605 + - *309 + - *310 + - *610 requestBody: required: true content: @@ -92946,7 +93601,7 @@ paths: login: type: string description: The username of the user credited. - type: *292 + type: *287 required: - login - type @@ -93037,17 +93692,17 @@ paths: description: Response content: application/json: - schema: *603 + schema: *608 examples: - default: *606 - add_credit: *606 + default: *611 + add_credit: *611 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *105 + schema: *104 examples: invalid_state_transition: value: @@ -93078,9 +93733,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: - - *314 - - *315 - - *605 + - *309 + - *310 + - *610 responses: '202': *37 '400': *14 @@ -93107,17 +93762,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *314 - - *315 - - *605 + - *309 + - *310 + - *610 responses: '202': description: Response content: application/json: - schema: *322 + schema: *317 examples: - default: *324 + default: *319 '400': *14 '422': *15 '403': *27 @@ -93143,8 +93798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -93218,7 +93873,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 '422': *15 x-github: githubCloudOnly: false @@ -93240,8 +93895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -93250,7 +93905,7 @@ paths: application/json: schema: type: array - items: &607 + items: &612 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -93263,7 +93918,7 @@ paths: - 1124 - -435 '202': *37 - '204': *156 + '204': *165 '422': description: Repository contains more than 10,000 commits x-github: @@ -93283,8 +93938,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -93335,7 +93990,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *156 + '204': *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93362,8 +94017,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -93435,7 +94090,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *156 + '204': *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93457,8 +94112,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -93612,8 +94267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -93623,7 +94278,7 @@ paths: application/json: schema: type: array - items: *607 + items: *612 examples: default: value: @@ -93636,7 +94291,7 @@ paths: - - 0 - 2 - 21 - '204': *156 + '204': *165 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93656,8 +94311,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *314 - - *315 + - *309 + - *310 - name: sha in: path required: true @@ -93713,7 +94368,7 @@ paths: description: Response content: application/json: - schema: *608 + schema: *613 examples: default: value: @@ -93767,8 +94422,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -93780,9 +94435,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93800,14 +94455,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &609 + schema: &614 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -93880,8 +94535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: false content: @@ -93907,7 +94562,7 @@ paths: description: Response content: application/json: - schema: *609 + schema: *614 examples: default: value: @@ -93934,8 +94589,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -93955,8 +94610,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -94015,7 +94670,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94038,8 +94693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -94047,7 +94702,7 @@ paths: application/json: schema: type: array - items: &610 + items: &615 title: Tag protection description: Tag protection type: object @@ -94104,8 +94759,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: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -94128,7 +94783,7 @@ paths: description: Response content: application/json: - schema: *610 + schema: *615 examples: default: value: @@ -94159,8 +94814,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: - - *314 - - *315 + - *309 + - *310 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -94197,8 +94852,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *314 - - *315 + - *309 + - *310 - name: ref in: path required: true @@ -94234,8 +94889,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *314 - - *315 + - *309 + - *310 - *17 - *19 responses: @@ -94245,11 +94900,11 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - default: *215 + default: *221 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -94267,8 +94922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *314 - - *315 + - *309 + - *310 - *19 - *17 responses: @@ -94276,7 +94931,7 @@ paths: description: Response content: application/json: - schema: &611 + schema: &616 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -94288,7 +94943,7 @@ paths: required: - names examples: - default: &612 + default: &617 value: names: - octocat @@ -94311,8 +94966,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -94343,9 +94998,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *616 examples: - default: *612 + default: *617 '404': *6 '422': *7 x-github: @@ -94366,9 +95021,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *314 - - *315 - - &613 + - *309 + - *310 + - &618 name: per description: The time frame to display results for. in: query @@ -94399,7 +95054,7 @@ paths: - 128 clones: type: array - items: &614 + items: &619 title: Traffic type: object properties: @@ -94486,8 +95141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -94581,8 +95236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *314 - - *315 + - *309 + - *310 responses: '200': description: Response @@ -94645,9 +95300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *314 - - *315 - - *613 + - *309 + - *310 + - *618 responses: '200': description: Response @@ -94668,7 +95323,7 @@ paths: - 3782 views: type: array - items: *614 + items: *619 required: - uniques - count @@ -94745,8 +95400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *314 - - *315 + - *309 + - *310 requestBody: required: true content: @@ -94782,7 +95437,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *135 examples: default: value: @@ -95020,8 +95675,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -95044,8 +95699,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -95067,8 +95722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -95094,8 +95749,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *314 - - *315 + - *309 + - *310 - name: ref in: path required: true @@ -95187,9 +95842,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *317 examples: - default: *324 + default: *319 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -95230,7 +95885,7 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: default: value: @@ -95419,7 +96074,7 @@ paths: html_url: type: string format: uri - repository: *131 + repository: *135 score: type: number file_size: @@ -95438,7 +96093,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &615 + text_matches: &620 title: Search Result Text Matches type: array items: @@ -95553,7 +96208,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *73 + '503': *99 '422': *15 '403': *27 x-github: @@ -95601,7 +96256,7 @@ paths: enum: - author-date - committer-date - - &616 + - &621 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 @@ -95670,7 +96325,7 @@ paths: committer: anyOf: - type: 'null' - - *382 + - *377 comment_count: type: integer message: @@ -95689,7 +96344,7 @@ paths: url: type: string format: uri - verification: *492 + verification: *487 required: - author - committer @@ -95704,7 +96359,7 @@ paths: committer: anyOf: - type: 'null' - - *382 + - *377 parents: type: array items: @@ -95716,12 +96371,12 @@ paths: type: string sha: type: string - repository: *131 + repository: *135 score: type: number node_id: type: string - text_matches: *615 + text_matches: *620 required: - sha - node_id @@ -95913,7 +96568,7 @@ paths: - interactions - created - updated - - *616 + - *621 - *17 - *19 - name: advanced_search @@ -96010,11 +96665,11 @@ paths: type: - string - 'null' - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: type: string state_reason: @@ -96028,7 +96683,7 @@ paths: milestone: anyOf: - type: 'null' - - *238 + - *244 comments: type: integer created_at: @@ -96042,7 +96697,7 @@ paths: - string - 'null' format: date-time - text_matches: *615 + text_matches: *620 pull_request: type: object properties: @@ -96080,10 +96735,10 @@ paths: type: string score: type: number - author_association: *69 + author_association: *67 draft: type: boolean - repository: *66 + repository: *64 body_html: type: string body_text: @@ -96091,12 +96746,12 @@ paths: timeline_url: type: string format: uri - type: *199 + type: *205 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *70 + reactions: *68 required: - assignee - closed_at @@ -96212,7 +96867,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *73 + '503': *99 '422': *15 '304': *35 '403': *27 @@ -96265,7 +96920,7 @@ paths: enum: - created - updated - - *616 + - *621 - *17 - *19 responses: @@ -96310,7 +96965,7 @@ paths: - 'null' score: type: number - text_matches: *615 + text_matches: *620 required: - id - node_id @@ -96395,7 +97050,7 @@ paths: - forks - help-wanted-issues - updated - - *616 + - *621 - *17 - *19 responses: @@ -96614,7 +97269,7 @@ paths: license: anyOf: - type: 'null' - - *71 + - *69 permissions: type: object properties: @@ -96632,7 +97287,7 @@ paths: - admin - pull - push - text_matches: *615 + text_matches: *620 temp_clone_token: type: string allow_merge_commit: @@ -96835,7 +97490,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *73 + '503': *99 '422': *15 '304': *35 x-github: @@ -96940,7 +97595,7 @@ paths: - string - 'null' format: uri - text_matches: *615 + text_matches: *620 related: type: - array @@ -97133,7 +97788,7 @@ paths: - followers - repositories - joined - - *616 + - *621 - *17 - *19 responses: @@ -97243,7 +97898,7 @@ paths: type: - boolean - 'null' - text_matches: *615 + text_matches: *620 blog: type: - string @@ -97305,7 +97960,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *73 + '503': *99 '422': *15 x-github: githubCloudOnly: false @@ -97325,7 +97980,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &620 + - &625 name: team_id description: The unique identifier of the team. in: path @@ -97337,9 +97992,9 @@ paths: description: Response content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '404': *6 x-github: githubCloudOnly: false @@ -97366,7 +98021,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *620 + - *625 requestBody: required: true content: @@ -97430,16 +98085,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '201': description: Response content: application/json: - schema: *299 + schema: *294 examples: - default: *300 + default: *295 '404': *6 '422': *15 '403': *27 @@ -97467,7 +98122,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *620 + - *625 responses: '204': description: Response @@ -97498,7 +98153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *620 + - *625 - *46 - *17 - *19 @@ -97509,11 +98164,11 @@ paths: application/json: schema: type: array - items: *301 + items: *296 examples: - default: *621 + default: *626 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97540,7 +98195,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *620 + - *625 requestBody: required: true content: @@ -97574,9 +98229,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: *302 + default: *297 x-github: triggersNotification: true githubCloudOnly: false @@ -97603,16 +98258,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *620 - - *303 + - *625 + - *298 responses: '200': description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: *302 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97637,8 +98292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *620 - - *303 + - *625 + - *298 requestBody: required: false content: @@ -97661,9 +98316,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *296 examples: - default: *622 + default: *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97688,8 +98343,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *620 - - *303 + - *625 + - *298 responses: '204': description: Response @@ -97718,8 +98373,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *620 - - *303 + - *625 + - *298 - *46 - *17 - *19 @@ -97730,11 +98385,11 @@ paths: application/json: schema: type: array - items: *304 + items: *299 examples: - default: *623 + default: *628 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97761,8 +98416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *620 - - *303 + - *625 + - *298 requestBody: required: true content: @@ -97784,9 +98439,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: *305 + default: *300 x-github: triggersNotification: true githubCloudOnly: false @@ -97813,17 +98468,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *620 - - *303 - - *306 + - *625 + - *298 + - *301 responses: '200': description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: *305 + default: *300 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97848,9 +98503,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *620 - - *303 - - *306 + - *625 + - *298 + - *301 requestBody: required: true content: @@ -97872,9 +98527,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *299 examples: - default: *624 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97899,9 +98554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *620 - - *303 - - *306 + - *625 + - *298 + - *301 responses: '204': description: Response @@ -97930,9 +98585,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *620 - - *303 - - *306 + - *625 + - *298 + - *301 - 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. @@ -97958,11 +98613,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97989,9 +98644,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *620 - - *303 - - *306 + - *625 + - *298 + - *301 requestBody: required: true content: @@ -98023,9 +98678,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98051,8 +98706,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *620 - - *303 + - *625 + - *298 - 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. @@ -98078,11 +98733,11 @@ paths: application/json: schema: type: array - items: *307 + items: *302 examples: - default: *309 + default: *304 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98109,8 +98764,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *620 - - *303 + - *625 + - *298 requestBody: required: true content: @@ -98142,9 +98797,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *302 examples: - default: *308 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98168,7 +98823,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *620 + - *625 - *17 - *19 responses: @@ -98178,11 +98833,11 @@ paths: application/json: schema: type: array - items: *196 + items: *202 examples: - default: *197 + default: *203 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98206,7 +98861,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *620 + - *625 - name: role description: Filters members returned by their role in the team. in: query @@ -98229,9 +98884,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -98257,8 +98912,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *620 - - *62 + - *625 + - *57 responses: '204': description: if user is a member @@ -98294,8 +98949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *620 - - *62 + - *625 + - *57 responses: '204': description: Response @@ -98334,8 +98989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *620 - - *62 + - *625 + - *57 responses: '204': description: Response @@ -98371,16 +99026,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *620 - - *62 + - *625 + - *57 responses: '200': description: Response content: application/json: - schema: *311 + schema: *306 examples: - response-if-user-is-a-team-maintainer: *625 + response-if-user-is-a-team-maintainer: *630 '404': *6 x-github: githubCloudOnly: false @@ -98413,8 +99068,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *620 - - *62 + - *625 + - *57 requestBody: required: false content: @@ -98439,9 +99094,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *306 examples: - response-if-users-membership-with-team-is-now-pending: *626 + response-if-users-membership-with-team-is-now-pending: *631 '403': description: Forbidden if team synchronization is set up '422': @@ -98475,8 +99130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *620 - - *62 + - *625 + - *57 responses: '204': description: Response @@ -98504,7 +99159,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *620 + - *625 - *17 - *19 responses: @@ -98514,11 +99169,11 @@ paths: application/json: schema: type: array - items: *312 + items: *307 examples: - default: *627 + default: *632 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -98542,16 +99197,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *620 - - *313 + - *625 + - *308 responses: '200': description: Response content: application/json: - schema: *312 + schema: *307 examples: - default: *628 + default: *633 '404': description: Not Found if project is not managed by this team x-github: @@ -98575,8 +99230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *620 - - *313 + - *625 + - *308 requestBody: required: false content: @@ -98643,8 +99298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *620 - - *313 + - *625 + - *308 responses: '204': description: Response @@ -98671,7 +99326,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *620 + - *625 - *17 - *19 responses: @@ -98681,11 +99336,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -98713,15 +99368,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *620 - - *314 - - *315 + - *625 + - *309 + - *310 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *629 + schema: *634 examples: alternative-response-with-extra-repository-information: value: @@ -98872,9 +99527,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *620 - - *314 - - *315 + - *625 + - *309 + - *310 requestBody: required: false content: @@ -98924,9 +99579,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *620 - - *314 - - *315 + - *625 + - *309 + - *310 responses: '204': description: Response @@ -98951,7 +99606,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *620 + - *625 - *17 - *19 responses: @@ -98961,11 +99616,11 @@ paths: application/json: schema: type: array - items: *161 + items: *169 examples: - response-if-child-teams-exist: *630 + response-if-child-teams-exist: *635 headers: - Link: *57 + Link: *52 '404': *6 '403': *27 '422': *15 @@ -98996,7 +99651,7 @@ paths: application/json: schema: oneOf: - - &632 + - &637 title: Private User description: Private User type: object @@ -99246,7 +99901,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *631 + - *636 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -99406,7 +100061,7 @@ paths: description: Response content: application/json: - schema: *632 + schema: *637 examples: default: value: @@ -99485,7 +100140,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 '304': *35 '404': *6 '403': *27 @@ -99508,7 +100163,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: - - *62 + - *57 responses: '204': description: If the user is blocked @@ -99536,7 +100191,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *62 + - *57 responses: '204': description: Response @@ -99560,7 +100215,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *62 + - *57 responses: '204': description: Response @@ -99609,11 +100264,11 @@ paths: type: integer codespaces: type: array - items: *204 + items: *210 examples: - default: *205 + default: *211 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -99750,21 +100405,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '401': *23 '403': *27 '404': *6 - '503': *73 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99804,7 +100459,7 @@ paths: type: integer secrets: type: array - items: &633 + items: &638 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -99846,9 +100501,9 @@ paths: - visibility - selected_repositories_url examples: - default: *436 + default: *431 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99918,13 +100573,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *139 + - *143 responses: '200': description: Response content: application/json: - schema: *633 + schema: *638 examples: default: value: @@ -99954,7 +100609,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *139 + - *143 requestBody: required: true content: @@ -99999,7 +100654,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -100027,7 +100682,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *139 + - *143 responses: '204': description: Response @@ -100052,7 +100707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *139 + - *143 responses: '200': description: Response @@ -100068,13 +100723,13 @@ paths: type: integer repositories: type: array - items: *131 + items: *135 examples: - default: *634 + default: *639 '401': *23 '403': *27 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100095,7 +100750,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *139 + - *143 requestBody: required: true content: @@ -100127,7 +100782,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100149,7 +100804,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *139 + - *143 - name: repository_id in: path required: true @@ -100161,7 +100816,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100182,7 +100837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *139 + - *143 - name: repository_id in: path required: true @@ -100194,7 +100849,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *100 + '500': *98 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100214,17 +100869,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -100248,7 +100903,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 requestBody: required: false content: @@ -100278,9 +100933,9 @@ paths: description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '401': *23 '403': *27 '404': *6 @@ -100302,11 +100957,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 responses: '202': *37 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -100331,13 +100986,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 responses: '202': description: Response content: application/json: - schema: &635 + schema: &640 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100390,7 +101045,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &636 + default: &641 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100398,7 +101053,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -100422,7 +101077,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *206 + - *212 - name: export_id in: path required: true @@ -100435,9 +101090,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *640 examples: - default: *636 + default: *641 '404': *6 x-github: githubCloudOnly: false @@ -100458,7 +101113,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *206 + - *212 responses: '200': description: Response @@ -100474,11 +101129,11 @@ paths: type: integer machines: type: array - items: *435 + items: *430 examples: - default: *637 + default: *642 '304': *35 - '500': *100 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -100505,7 +101160,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *206 + - *212 requestBody: required: true content: @@ -100561,11 +101216,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *322 + repository: *317 machine: anyOf: - type: 'null' - - *435 + - *430 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -101362,17 +102017,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *434 + default: *429 '304': *35 - '500': *100 + '500': *98 '400': *14 '401': *23 '402': @@ -101402,16 +102057,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *206 + - *212 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *434 - '500': *100 + default: *429 + '500': *98 '401': *23 '403': *27 '404': *6 @@ -101440,9 +102095,9 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: &649 + default: &653 value: - id: 197 name: hello_docker @@ -101543,7 +102198,7 @@ paths: application/json: schema: type: array - items: &638 + items: &643 title: Email description: Email type: object @@ -101613,16 +102268,16 @@ paths: application/json: schema: type: array - items: *638 + items: *643 examples: - default: &651 + default: &655 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -101692,7 +102347,7 @@ paths: application/json: schema: type: array - items: *638 + items: *643 examples: default: value: @@ -101804,9 +102459,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -101837,9 +102492,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -101859,7 +102514,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: - - *62 + - *57 responses: '204': description: if the person is followed by the authenticated user @@ -101889,7 +102544,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *62 + - *57 responses: '204': description: Response @@ -101914,7 +102569,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *62 + - *57 responses: '204': description: Response @@ -101950,7 +102605,7 @@ paths: application/json: schema: type: array - items: &639 + items: &644 title: GPG Key description: A unique encryption key type: object @@ -102095,7 +102750,7 @@ paths: - subkeys - revoked examples: - default: &665 + default: &669 value: - id: 3 name: Octocat's GPG Key @@ -102127,7 +102782,7 @@ paths: revoked: false raw_key: string headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -102180,9 +102835,9 @@ paths: description: Response content: application/json: - schema: *639 + schema: *644 examples: - default: &640 + default: &645 value: id: 3 name: Octocat's GPG Key @@ -102239,7 +102894,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &641 + - &646 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102251,9 +102906,9 @@ paths: description: Response content: application/json: - schema: *639 + schema: *644 examples: - default: *640 + default: *645 '404': *6 '304': *35 '403': *27 @@ -102276,7 +102931,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *641 + - *646 responses: '204': description: Response @@ -102419,7 +103074,7 @@ paths: suspended_at: suspended_by: headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -102465,11 +103120,11 @@ paths: type: string repositories: type: array - items: *66 + items: *64 examples: - default: *123 + default: *127 headers: - Link: *57 + Link: *52 '404': *6 '403': *27 '304': *35 @@ -102492,7 +103147,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *120 + - *124 responses: '204': description: Response @@ -102518,7 +103173,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *120 + - *124 responses: '204': description: Response @@ -102552,12 +103207,12 @@ paths: application/json: schema: anyOf: - - *194 + - *200 - type: object properties: {} additionalProperties: false examples: - default: *195 + default: *201 '204': description: Response when there are no restrictions x-github: @@ -102581,7 +103236,7 @@ paths: required: true content: application/json: - schema: *503 + schema: *498 examples: default: value: @@ -102592,7 +103247,7 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: default: value: @@ -102673,7 +103328,7 @@ paths: - closed - all default: open - - *202 + - *208 - name: sort description: What to sort results by. in: query @@ -102686,7 +103341,7 @@ paths: - comments default: created - *46 - - *75 + - *72 - *17 - *19 responses: @@ -102696,11 +103351,11 @@ paths: application/json: schema: type: array - items: *68 + items: *66 examples: - default: *203 + default: *209 headers: - Link: *57 + Link: *52 '404': *6 '304': *35 x-github: @@ -102731,7 +103386,7 @@ paths: application/json: schema: type: array - items: &642 + items: &647 title: Key description: Key type: object @@ -102783,7 +103438,7 @@ paths: verified: false read_only: false headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -102834,9 +103489,9 @@ paths: description: Response content: application/json: - schema: *642 + schema: *647 examples: - default: &643 + default: &648 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -102869,15 +103524,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *529 + - *524 responses: '200': description: Response content: application/json: - schema: *642 + schema: *647 examples: - default: *643 + default: *648 '404': *6 '304': *35 '403': *27 @@ -102900,7 +103555,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *529 + - *524 responses: '204': description: Response @@ -102933,7 +103588,7 @@ paths: application/json: schema: type: array - items: &644 + items: &649 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -103001,7 +103656,7 @@ paths: - id - type - login - plan: *86 + plan: *83 required: - billing_cycle - next_billing_date @@ -103012,7 +103667,7 @@ paths: - account - plan examples: - default: &645 + default: &650 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -103045,7 +103700,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *57 + Link: *52 '304': *35 '401': *23 '404': *6 @@ -103074,11 +103729,11 @@ paths: application/json: schema: type: array - items: *644 + items: *649 examples: - default: *645 + default: *650 headers: - Link: *57 + Link: *52 '304': *35 '401': *23 x-github: @@ -103116,7 +103771,7 @@ paths: application/json: schema: type: array - items: *208 + items: *214 examples: default: value: @@ -103193,7 +103848,7 @@ paths: type: User site_admin: false headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -103218,13 +103873,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *99 + - *61 responses: '200': description: Response content: application/json: - schema: *208 + schema: *214 examples: default: value: @@ -103282,7 +103937,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *99 + - *61 requestBody: required: true content: @@ -103307,7 +103962,7 @@ paths: description: Response content: application/json: - schema: *208 + schema: *214 examples: default: value: @@ -103375,7 +104030,7 @@ paths: application/json: schema: type: array - items: *210 + items: *216 examples: default: value: @@ -103528,7 +104183,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -103637,7 +104292,7 @@ paths: description: Response content: application/json: - schema: *210 + schema: *216 examples: default: value: @@ -103817,7 +104472,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *211 + - *217 - name: exclude in: query required: false @@ -103830,7 +104485,7 @@ paths: description: Response content: application/json: - schema: *210 + schema: *216 examples: default: value: @@ -104024,7 +104679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *211 + - *217 responses: '302': description: Response @@ -104050,7 +104705,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *211 + - *217 responses: '204': description: Response @@ -104079,8 +104734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *211 - - *646 + - *217 + - *651 responses: '204': description: Response @@ -104104,7 +104759,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *211 + - *217 - *17 - *19 responses: @@ -104114,11 +104769,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 '404': *6 x-github: githubCloudOnly: false @@ -104151,11 +104806,11 @@ paths: application/json: schema: type: array - items: *160 + items: *59 examples: - default: *647 + default: *96 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -104195,7 +104850,7 @@ paths: - docker - nuget - container - - *648 + - *652 - *19 - *17 responses: @@ -104205,10 +104860,10 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *649 - '400': *650 + default: *653 + '400': *654 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104228,16 +104883,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *218 - - *219 + - *224 + - *225 responses: '200': description: Response content: application/json: - schema: *216 + schema: *222 examples: - default: &666 + default: &670 value: id: 40201 name: octo-name @@ -104350,8 +105005,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *218 - - *219 + - *224 + - *225 responses: '204': description: Response @@ -104381,8 +105036,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *218 - - *219 + - *224 + - *225 - name: token description: package token schema: @@ -104414,8 +105069,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: - - *218 - - *219 + - *224 + - *225 - *19 - *17 - name: state @@ -104435,7 +105090,7 @@ paths: application/json: schema: type: array - items: *220 + items: *226 examples: default: value: @@ -104484,15 +105139,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *218 - - *219 - - *221 + - *224 + - *225 + - *227 responses: '200': description: Response content: application/json: - schema: *220 + schema: *226 examples: default: value: @@ -104528,9 +105183,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *218 - - *219 - - *221 + - *224 + - *225 + - *227 responses: '204': description: Response @@ -104560,9 +105215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *218 - - *219 - - *221 + - *224 + - *225 + - *227 responses: '204': description: Response @@ -104620,7 +105275,7 @@ paths: description: Response content: application/json: - schema: *232 + schema: *238 examples: default: value: @@ -104692,11 +105347,11 @@ paths: application/json: schema: type: array - items: *638 + items: *643 examples: - default: *651 + default: *655 headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -104805,9 +105460,9 @@ paths: application/json: schema: type: array - items: *66 + items: *64 examples: - default: &658 + default: &662 summary: Default response value: - id: 1296269 @@ -104928,7 +105583,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *57 + Link: *52 '422': *15 '304': *35 '403': *27 @@ -105125,9 +105780,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *317 examples: - default: *324 + default: *319 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105165,11 +105820,11 @@ paths: application/json: schema: type: array - items: *505 + items: *500 examples: - default: *652 + default: *656 headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -105190,7 +105845,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *198 + - *204 responses: '204': description: Response @@ -105213,7 +105868,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *198 + - *204 responses: '204': description: Response @@ -105246,7 +105901,7 @@ paths: application/json: schema: type: array - items: &653 + items: &657 title: Social account description: Social media account type: object @@ -105263,12 +105918,12 @@ paths: - provider - url examples: - default: &654 + default: &658 value: - provider: twitter url: https://twitter.com/github headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -105326,9 +105981,9 @@ paths: application/json: schema: type: array - items: *653 + items: *657 examples: - default: *654 + default: *658 '422': *15 '304': *35 '404': *6 @@ -105416,7 +106071,7 @@ paths: application/json: schema: type: array - items: &655 + items: &659 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105436,7 +106091,7 @@ paths: - title - created_at examples: - default: &680 + default: &684 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105449,7 +106104,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -105503,9 +106158,9 @@ paths: description: Response content: application/json: - schema: *655 + schema: *659 examples: - default: &656 + default: &660 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105536,7 +106191,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: - - &657 + - &661 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105548,9 +106203,9 @@ paths: description: Response content: application/json: - schema: *655 + schema: *659 examples: - default: *656 + default: *660 '404': *6 '304': *35 '403': *27 @@ -105573,7 +106228,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: - - *657 + - *661 responses: '204': description: Response @@ -105602,7 +106257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &681 + - &685 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 @@ -105625,13 +106280,13 @@ paths: application/json: schema: type: array - items: *66 + items: *64 examples: - default-response: *658 + default-response: *662 application/vnd.github.v3.star+json: schema: type: array - items: &682 + items: &686 title: Starred Repository description: Starred Repository type: object @@ -105639,7 +106294,7 @@ paths: starred_at: type: string format: date-time - repo: *66 + repo: *64 required: - starred_at - repo @@ -105767,7 +106422,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -105787,8 +106442,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: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response if this repository is starred by you @@ -105816,8 +106471,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -105841,8 +106496,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *314 - - *315 + - *309 + - *310 responses: '204': description: Response @@ -105875,11 +106530,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -105914,7 +106569,7 @@ paths: application/json: schema: type: array - items: *299 + items: *294 examples: default: value: @@ -105965,7 +106620,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *57 + Link: *52 '304': *35 '404': *6 '403': *27 @@ -105992,7 +106647,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *88 + - *85 responses: '200': description: Response @@ -106000,10 +106655,10 @@ paths: application/json: schema: oneOf: - - *632 - - *631 + - *637 + - *636 examples: - default-response: &660 + default-response: &664 summary: Default response value: login: octocat @@ -106038,7 +106693,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &661 + response-with-git-hub-plan-information: &665 summary: Response with GitHub plan information value: login: octocat @@ -106098,7 +106753,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *659 + - *663 - *17 responses: '200': @@ -106109,7 +106764,7 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: Link: example: ; rel="next" @@ -106139,7 +106794,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *62 + - *57 responses: '200': description: Response @@ -106147,11 +106802,11 @@ paths: application/json: schema: oneOf: - - *632 - - *631 + - *637 + - *636 examples: - default-response: *660 - response-with-git-hub-plan-information: *661 + default-response: *664 + response-with-git-hub-plan-information: *665 '404': *6 x-github: githubCloudOnly: false @@ -106177,7 +106832,7 @@ paths: - *17 - *38 - *39 - - *62 + - *57 requestBody: required: true content: @@ -106200,8 +106855,8 @@ paths: required: - subject_digests examples: - default: *662 - withPredicateType: *663 + default: *666 + withPredicateType: *667 responses: '200': description: Response @@ -106255,7 +106910,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *664 + default: *668 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106273,7 +106928,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *62 + - *57 requestBody: required: true content: @@ -106338,7 +106993,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *62 + - *57 - name: subject_digest description: Subject Digest in: path @@ -106369,7 +107024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *62 + - *57 - name: attestation_id description: Attestation ID in: path @@ -106407,7 +107062,7 @@ paths: - *17 - *38 - *39 - - *62 + - *57 - name: subject_digest description: Subject Digest in: path @@ -106459,12 +107114,12 @@ paths: initiator: type: string examples: - default: *378 + default: *373 '201': description: Response content: application/json: - schema: *140 + schema: *144 examples: default: value: @@ -106490,7 +107145,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: - - *62 + - *57 responses: '200': description: Response @@ -106498,9 +107153,9 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *649 + default: *653 '403': *27 '401': *23 x-github: @@ -106523,7 +107178,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -106533,7 +107188,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -106595,8 +107250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *62 - - *99 + - *57 + - *61 - *17 - *19 responses: @@ -106606,7 +107261,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -106683,7 +107338,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -106693,7 +107348,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -106751,7 +107406,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -106763,9 +107418,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106782,7 +107437,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *62 + - *57 - *17 - *19 responses: @@ -106794,9 +107449,9 @@ paths: type: array items: *4 examples: - default: *61 + default: *56 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106813,7 +107468,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *62 + - *57 - name: target_user in: path required: true @@ -106840,8 +107495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *62 - - *75 + - *57 + - *72 - *17 - *19 responses: @@ -106851,11 +107506,11 @@ paths: application/json: schema: type: array - items: *76 + items: *73 examples: - default: *77 + default: *74 headers: - Link: *57 + Link: *52 '422': *15 x-github: githubCloudOnly: false @@ -106874,7 +107529,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -106884,11 +107539,11 @@ paths: application/json: schema: type: array - items: *639 + items: *644 examples: - default: *665 + default: *669 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106910,7 +107565,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *62 + - *57 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -106982,7 +107637,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *62 + - *57 responses: '200': description: Response @@ -106990,7 +107645,7 @@ paths: application/json: schema: *20 examples: - default: *502 + default: *497 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107008,7 +107663,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -107044,7 +107699,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107064,7 +107719,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -107074,11 +107729,11 @@ paths: application/json: schema: type: array - items: *160 + items: *59 examples: - default: *647 + default: *96 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107115,8 +107770,8 @@ paths: - docker - nuget - container - - *648 - - *62 + - *652 + - *57 - *19 - *17 responses: @@ -107126,12 +107781,12 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *649 + default: *653 '403': *27 '401': *23 - '400': *650 + '400': *654 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107151,17 +107806,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *218 - - *219 - - *62 + - *224 + - *225 + - *57 responses: '200': description: Response content: application/json: - schema: *216 + schema: *222 examples: - default: *666 + default: *670 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107182,9 +107837,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *218 - - *219 - - *62 + - *224 + - *225 + - *57 responses: '204': description: Response @@ -107216,9 +107871,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *218 - - *219 - - *62 + - *224 + - *225 + - *57 - name: token description: package token schema: @@ -107250,9 +107905,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: - - *218 - - *219 - - *62 + - *224 + - *225 + - *57 responses: '200': description: Response @@ -107260,7 +107915,7 @@ paths: application/json: schema: type: array - items: *220 + items: *226 examples: default: value: @@ -107318,16 +107973,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *218 - - *219 - - *221 - - *62 + - *224 + - *225 + - *227 + - *57 responses: '200': description: Response content: application/json: - schema: *220 + schema: *226 examples: default: value: @@ -107362,10 +108017,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *218 - - *219 - - *62 - - *221 + - *224 + - *225 + - *57 + - *227 responses: '204': description: Response @@ -107397,10 +108052,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *218 - - *219 - - *62 - - *221 + - *224 + - *225 + - *57 + - *227 responses: '204': description: Response @@ -107426,7 +108081,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-user-projects parameters: - - *62 + - *57 - name: state description: Indicates the state of the projects to return. in: query @@ -107447,7 +108102,7 @@ paths: application/json: schema: type: array - items: *232 + items: *238 examples: default: value: @@ -107483,7 +108138,7 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *57 + Link: *52 '422': *15 x-github: githubCloudOnly: false @@ -107505,7 +108160,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *62 + - *57 - name: q description: Limit results to projects of the specified type. in: query @@ -107522,11 +108177,11 @@ paths: application/json: schema: type: array - items: *233 + items: *239 examples: - default: *234 + default: *240 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107546,18 +108201,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *235 - - *62 + - *241 + - *57 responses: '200': description: Response content: application/json: - schema: *233 + schema: *239 examples: - default: *234 + default: *240 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107577,8 +108232,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *235 - - *62 + - *241 + - *57 - *17 - *38 - *39 @@ -107589,11 +108244,11 @@ paths: application/json: schema: type: array - items: *236 + items: *242 examples: - default: *237 + default: *243 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107613,19 +108268,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *235 - - *667 - - *62 + - *241 + - *671 + - *57 responses: '200': description: Response content: application/json: - schema: *236 + schema: *242 examples: - default: *237 + default: *243 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107646,8 +108301,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *235 - - *62 + - *241 + - *57 - *38 - *39 - *17 @@ -107659,17 +108314,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -107677,11 +108334,11 @@ paths: application/json: schema: type: array - items: *242 + items: *248 examples: - default: *243 + default: *249 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107700,8 +108357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *62 - - *235 + - *57 + - *241 requestBody: required: true description: Details of the item to add to the project. @@ -107738,10 +108395,10 @@ paths: description: Response content: application/json: - schema: *668 + schema: *672 examples: - issue: *241 - pull_request: *241 + issue: *247 + pull_request: *247 '304': *35 '403': *27 '401': *23 @@ -107761,31 +108418,33 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *235 - - *62 - - *244 + - *241 + - *57 + - *250 - 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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *242 + schema: *248 examples: - default: *243 + default: *249 headers: - Link: *57 + Link: *52 '304': *35 '403': *27 '401': *23 @@ -107804,9 +108463,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *235 - - *62 - - *244 + - *241 + - *57 + - *250 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -107879,13 +108538,13 @@ paths: description: Response content: application/json: - schema: *242 + schema: *248 examples: - text_field: *243 - number_field: *243 - date_field: *243 - single_select_field: *243 - iteration_field: *243 + text_field: *249 + number_field: *249 + date_field: *249 + single_select_field: *249 + iteration_field: *249 '401': *23 '403': *27 '404': *6 @@ -107905,9 +108564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *235 - - *62 - - *244 + - *241 + - *57 + - *250 responses: '204': description: Response @@ -107934,7 +108593,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -107944,7 +108603,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -108009,7 +108668,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -108019,7 +108678,7 @@ paths: application/json: schema: type: array - items: *94 + items: *91 examples: default: value: @@ -108082,7 +108741,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *62 + - *57 - name: type description: Limit results to repositories of the specified type. in: query @@ -108125,11 +108784,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108151,15 +108810,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *62 + - *57 responses: '200': description: Response content: application/json: - schema: *669 + schema: *673 examples: - default: *670 + default: *674 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108181,15 +108840,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *62 + - *57 responses: '200': description: Response content: application/json: - schema: *671 + schema: *675 examples: - default: *672 + default: *676 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108198,7 +108857,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 @@ -108206,12 +108868,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: - - *62 + - *57 + - *100 + - *677 - *101 - - *673 - - *102 - - *674 - - *675 + - *678 + - *679 responses: '200': description: Response when getting a billing premium request usage report @@ -108264,19 +108926,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 @@ -108318,8 +108980,8 @@ paths: '400': *14 '403': *27 '404': *6 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108341,15 +109003,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *62 + - *57 responses: '200': description: Response content: application/json: - schema: *676 + schema: *680 examples: - default: *677 + default: *681 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108369,11 +109031,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *62 + - *57 + - *100 + - *682 - *101 - - *678 - - *102 - - *679 + - *683 responses: '200': description: Response when getting a billing usage report @@ -108443,8 +109105,8 @@ paths: repositoryName: user/example '400': *14 '403': *27 - '500': *100 - '503': *73 + '500': *98 + '503': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108462,7 +109124,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -108472,11 +109134,11 @@ paths: application/json: schema: type: array - items: *653 + items: *657 examples: - default: *654 + default: *658 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108494,7 +109156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -108504,11 +109166,11 @@ paths: application/json: schema: type: array - items: *655 + items: *659 examples: - default: *680 + default: *684 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108530,8 +109192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *62 - - *681 + - *57 + - *685 - *46 - *17 - *19 @@ -108543,13 +109205,13 @@ paths: schema: anyOf: - type: array - items: *682 + items: *686 - type: array - items: *66 + items: *64 examples: - default-response: *658 + default-response: *662 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108566,7 +109228,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *62 + - *57 - *17 - *19 responses: @@ -108576,11 +109238,11 @@ paths: application/json: schema: type: array - items: *131 + items: *135 examples: - default: *222 + default: *228 headers: - Link: *57 + Link: *52 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108707,7 +109369,7 @@ webhooks: type: string enum: - disabled - enterprise: &683 + enterprise: &687 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -108776,7 +109438,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &684 + installation: &688 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -108797,7 +109459,7 @@ webhooks: required: - id - node_id - organization: &685 + organization: &689 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -108870,7 +109532,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &686 + repository: &690 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -108899,7 +109561,7 @@ webhooks: license: anyOf: - type: 'null' - - *71 + - *69 organization: anyOf: - type: 'null' @@ -109783,10 +110445,10 @@ webhooks: type: string enum: - enabled - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -109862,11 +110524,11 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - rule: &687 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + rule: &691 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) @@ -110089,11 +110751,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - rule: *687 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + rule: *691 sender: *4 required: - action @@ -110281,11 +110943,11 @@ webhooks: - everyone required: - from - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - rule: *687 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + rule: *691 sender: *4 required: - action @@ -110369,7 +111031,7 @@ webhooks: type: string enum: - completed - check_run: &689 + check_run: &693 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110434,8 +111096,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *72 - repository: *131 + items: *70 + repository: *135 status: type: string enum: @@ -110479,7 +111141,7 @@ webhooks: - examples: - neutral - deployment: *688 + deployment: *692 details_url: type: string examples: @@ -110539,7 +111201,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *72 + items: *70 started_at: type: string format: date-time @@ -110577,10 +111239,10 @@ webhooks: - output - app - pull_requests - installation: *684 - enterprise: *683 - organization: *685 - repository: *686 + installation: *688 + enterprise: *687 + organization: *689 + repository: *690 sender: *4 required: - check_run @@ -110973,11 +111635,11 @@ webhooks: type: string enum: - created - check_run: *689 - installation: *684 - enterprise: *683 - organization: *685 - repository: *686 + check_run: *693 + installation: *688 + enterprise: *687 + organization: *689 + repository: *690 sender: *4 required: - check_run @@ -111373,11 +112035,11 @@ webhooks: type: string enum: - requested_action - check_run: *689 - installation: *684 - enterprise: *683 - organization: *685 - repository: *686 + check_run: *693 + installation: *688 + enterprise: *687 + organization: *689 + repository: *690 requested_action: description: The action requested by the user. type: object @@ -111782,11 +112444,11 @@ webhooks: type: string enum: - rerequested - check_run: *689 - installation: *684 - enterprise: *683 - organization: *685 - repository: *686 + check_run: *693 + installation: *688 + enterprise: *687 + organization: *689 + repository: *690 sender: *4 required: - check_run @@ -112778,10 +113440,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -113466,10 +114128,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -114148,10 +114810,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -114320,7 +114982,7 @@ webhooks: required: - login - id - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114472,20 +115134,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &690 + commit_oid: &694 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: *683 - installation: *684 - organization: *685 - ref: &691 + enterprise: *687 + installation: *688 + organization: *689 + ref: &695 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: *686 + repository: *690 sender: *4 required: - action @@ -114652,7 +115314,7 @@ webhooks: required: - login - id - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114893,12 +115555,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *690 - enterprise: *683 - installation: *684 - organization: *685 - ref: *691 - repository: *686 + commit_oid: *694 + enterprise: *687 + installation: *688 + organization: *689 + ref: *695 + repository: *690 sender: *4 required: - action @@ -114996,7 +115658,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115181,12 +115843,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *690 - enterprise: *683 - installation: *684 - organization: *685 - ref: *691 - repository: *686 + commit_oid: *694 + enterprise: *687 + installation: *688 + organization: *689 + ref: *695 + repository: *690 sender: *4 required: - action @@ -115355,7 +116017,7 @@ webhooks: required: - login - id - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -115532,12 +116194,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *690 - enterprise: *683 - installation: *684 - organization: *685 - ref: *691 - repository: *686 + commit_oid: *694 + enterprise: *687 + installation: *688 + organization: *689 + ref: *695 + repository: *690 sender: *4 required: - action @@ -115640,7 +116302,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115820,9 +116482,9 @@ webhooks: type: - string - 'null' - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -115830,7 +116492,7 @@ webhooks: type: - string - 'null' - repository: *686 + repository: *690 sender: *4 required: - action @@ -115929,7 +116591,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *409 + dismissed_comment: *404 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116076,12 +116738,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *690 - enterprise: *683 - installation: *684 - organization: *685 - ref: *691 - repository: *686 + commit_oid: *694 + enterprise: *687 + installation: *688 + organization: *689 + ref: *695 + repository: *690 sender: *4 required: - action @@ -116343,10 +117005,10 @@ webhooks: - updated_at - author_association - body - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -116427,18 +117089,18 @@ webhooks: type: - string - 'null' - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *685 - pusher_type: &692 + organization: *689 + pusher_type: &696 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &693 + ref: &697 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -116448,7 +117110,7 @@ webhooks: enum: - tag - branch - repository: *686 + repository: *690 sender: *4 required: - ref @@ -116530,10 +117192,10 @@ webhooks: type: string enum: - created - definition: *245 - enterprise: *683 - installation: *684 - organization: *685 + definition: *251 + enterprise: *687 + installation: *688 + organization: *689 sender: *4 required: - action @@ -116618,9 +117280,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 sender: *4 required: - action @@ -116697,10 +117359,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *245 - enterprise: *683 - installation: *684 - organization: *685 + definition: *251 + enterprise: *687 + installation: *688 + organization: *689 sender: *4 required: - action @@ -116777,10 +117439,10 @@ webhooks: type: string enum: - updated - definition: *245 - enterprise: *683 - installation: *684 - organization: *685 + definition: *251 + enterprise: *687 + installation: *688 + organization: *689 sender: *4 required: - action @@ -116857,19 +117519,19 @@ webhooks: type: string enum: - updated - enterprise: *683 - installation: *684 - repository: *686 - organization: *685 + enterprise: *687 + installation: *688 + repository: *690 + organization: *689 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *249 + items: *97 old_property_values: type: array description: The old custom property values for the repository. - items: *249 + items: *97 required: - action - repository @@ -116945,18 +117607,18 @@ webhooks: title: delete event type: object properties: - enterprise: *683 - installation: *684 - organization: *685 - pusher_type: *692 - ref: *693 + enterprise: *687 + installation: *688 + organization: *689 + pusher_type: *696 + ref: *697 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *686 + repository: *690 sender: *4 required: - ref @@ -117040,11 +117702,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117128,11 +117790,11 @@ webhooks: type: string enum: - auto_reopened - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117216,11 +117878,11 @@ webhooks: type: string enum: - created - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117302,11 +117964,11 @@ webhooks: type: string enum: - dismissed - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117388,11 +118050,11 @@ webhooks: type: string enum: - fixed - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117475,11 +118137,11 @@ webhooks: type: string enum: - reintroduced - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117561,11 +118223,11 @@ webhooks: type: string enum: - reopened - alert: *461 - installation: *684 - organization: *685 - enterprise: *683 - repository: *686 + alert: *456 + installation: *688 + organization: *689 + enterprise: *687 + repository: *690 sender: *4 required: - action @@ -117642,9 +118304,9 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - key: &694 + enterprise: *687 + installation: *688 + key: &698 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -117682,8 +118344,8 @@ webhooks: - verified - created_at - read_only - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -117760,11 +118422,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - key: *694 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + key: *698 + organization: *689 + repository: *690 sender: *4 required: - action @@ -118336,12 +118998,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - workflow: &698 + workflow: &702 title: Workflow type: - object @@ -119079,13 +119741,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *467 + deployment: *462 pull_requests: type: array - items: *547 - repository: *686 - organization: *685 - installation: *684 + items: *544 + repository: *690 + organization: *689 + installation: *688 sender: *4 responses: '200': @@ -119156,7 +119818,7 @@ webhooks: type: string enum: - approved - approver: &695 + approver: &699 type: object properties: avatar_url: @@ -119199,11 +119861,11 @@ webhooks: type: string comment: type: string - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - reviewers: &696 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + reviewers: &700 type: array items: type: object @@ -119284,7 +119946,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &697 + workflow_job_run: &701 type: object properties: conclusion: @@ -120030,18 +120692,18 @@ webhooks: type: string enum: - rejected - approver: *695 + approver: *699 comment: type: string - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - reviewers: *696 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + reviewers: *700 sender: *4 since: type: string - workflow_job_run: *697 + workflow_job_run: *701 workflow_job_runs: type: array items: @@ -120758,13 +121420,13 @@ webhooks: type: string enum: - requested - enterprise: *683 + enterprise: *687 environment: type: string - installation: *684 - organization: *685 - repository: *686 - requestor: &703 + installation: *688 + organization: *689 + repository: *690 + requestor: &707 title: User type: - object @@ -122707,12 +123369,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - workflow: *698 + workflow: *702 workflow_run: title: Deployment Workflow Run type: @@ -123403,7 +124065,7 @@ webhooks: type: string enum: - answered - answer: &701 + answer: &705 type: object properties: author_association: @@ -123563,11 +124225,11 @@ webhooks: - created_at - updated_at - body - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -123694,11 +124356,11 @@ webhooks: - from required: - category - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -123781,11 +124443,11 @@ webhooks: type: string enum: - closed - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -123867,7 +124529,7 @@ webhooks: type: string enum: - created - comment: &700 + comment: &704 type: object properties: author_association: @@ -124027,11 +124689,11 @@ webhooks: - updated_at - body - reactions - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124114,12 +124776,12 @@ webhooks: type: string enum: - deleted - comment: *700 - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + comment: *704 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124214,12 +124876,12 @@ webhooks: - from required: - body - comment: *700 - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + comment: *704 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124303,11 +124965,11 @@ webhooks: type: string enum: - created - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124389,11 +125051,11 @@ webhooks: type: string enum: - deleted - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124493,11 +125155,11 @@ webhooks: type: string required: - from - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124579,10 +125241,10 @@ webhooks: type: string enum: - labeled - discussion: *699 - enterprise: *683 - installation: *684 - label: &702 + discussion: *703 + enterprise: *687 + installation: *688 + label: &706 title: Label type: object properties: @@ -124615,8 +125277,8 @@ webhooks: - color - default - description - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124699,11 +125361,11 @@ webhooks: type: string enum: - locked - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124785,11 +125447,11 @@ webhooks: type: string enum: - pinned - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124871,11 +125533,11 @@ webhooks: type: string enum: - reopened - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -124960,16 +125622,16 @@ webhooks: changes: type: object properties: - new_discussion: *699 - new_repository: *686 + new_discussion: *703 + new_repository: *690 required: - new_discussion - new_repository - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -125052,10 +125714,10 @@ webhooks: type: string enum: - unanswered - discussion: *699 - old_answer: *701 - organization: *685 - repository: *686 + discussion: *703 + old_answer: *705 + organization: *689 + repository: *690 sender: *4 required: - action @@ -125137,12 +125799,12 @@ webhooks: type: string enum: - unlabeled - discussion: *699 - enterprise: *683 - installation: *684 - label: *702 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -125225,11 +125887,11 @@ webhooks: type: string enum: - unlocked - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -125311,11 +125973,11 @@ webhooks: type: string enum: - unpinned - discussion: *699 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + discussion: *703 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -125388,7 +126050,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *683 + enterprise: *687 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -126066,9 +126728,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *684 - organization: *685 - repository: *686 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - forkee @@ -126214,9 +126876,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pages: description: The pages that were updated. type: array @@ -126254,7 +126916,7 @@ webhooks: - action - sha - html_url - repository: *686 + repository: *690 sender: *4 required: - pages @@ -126330,10 +126992,10 @@ webhooks: type: string enum: - created - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories: &704 + organization: *689 + repositories: &708 description: An array of repository objects that the installation can access. type: array @@ -126359,8 +127021,8 @@ webhooks: - name - full_name - private - repository: *686 - requester: *703 + repository: *690 + requester: *707 sender: *4 required: - action @@ -126435,11 +127097,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories: *704 - repository: *686 + organization: *689 + repositories: *708 + repository: *690 requester: type: - 'null' @@ -126516,11 +127178,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories: *704 - repository: *686 + organization: *689 + repositories: *708 + repository: *690 requester: type: - 'null' @@ -126597,10 +127259,10 @@ webhooks: type: string enum: - added - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories_added: &705 + organization: *689 + repositories_added: &709 description: An array of repository objects, which were added to the installation. type: array @@ -126646,15 +127308,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *686 - repository_selection: &706 + repository: *690 + repository_selection: &710 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *703 + requester: *707 sender: *4 required: - action @@ -126733,10 +127395,10 @@ webhooks: type: string enum: - removed - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories_added: *705 + organization: *689 + repositories_added: *709 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -126763,9 +127425,9 @@ webhooks: - name - full_name - private - repository: *686 - repository_selection: *706 - requester: *703 + repository: *690 + repository_selection: *710 + requester: *707 sender: *4 required: - action @@ -126844,11 +127506,11 @@ webhooks: type: string enum: - suspend - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories: *704 - repository: *686 + organization: *689 + repositories: *708 + repository: *690 requester: type: - 'null' @@ -127030,10 +127692,10 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 target_type: type: string @@ -127112,11 +127774,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *683 + enterprise: *687 installation: *20 - organization: *685 - repositories: *704 - repository: *686 + organization: *689 + repositories: *708 + repository: *690 requester: type: - 'null' @@ -127364,8 +128026,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128182,8 +128844,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128200,7 +128862,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -128544,8 +129206,8 @@ webhooks: - state - locked - assignee - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -128625,7 +129287,7 @@ webhooks: type: string enum: - deleted - comment: &707 + comment: &711 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -128792,8 +129454,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129606,8 +130268,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129624,7 +130286,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -129970,8 +130632,8 @@ webhooks: - state - locked - assignee - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -130051,7 +130713,7 @@ webhooks: type: string enum: - edited - changes: &731 + changes: &735 description: The changes to the comment. type: object properties: @@ -130063,9 +130725,9 @@ webhooks: type: string required: - from - comment: *707 - enterprise: *683 - installation: *684 + comment: *711 + enterprise: *687 + installation: *688 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -130881,8 +131543,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130899,7 +131561,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -131243,8 +131905,8 @@ webhooks: - state - locked - assignee - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -131328,15 +131990,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *68 + blocked_issue: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *68 - blocking_issue_repo: *66 - installation: *684 - organization: *685 - repository: *686 + blocking_issue: *66 + blocking_issue_repo: *64 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -131424,15 +132086,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *68 + blocked_issue: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *68 - blocking_issue_repo: *66 - installation: *684 - organization: *685 - repository: *686 + blocking_issue: *66 + blocking_issue_repo: *64 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -131519,15 +132181,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *68 - blocked_issue_repo: *66 + blocked_issue: *66 + blocked_issue_repo: *64 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *68 - installation: *684 - organization: *685 - repository: *686 + blocking_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -131615,15 +132277,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *68 - blocked_issue_repo: *66 + blocked_issue: *66 + blocked_issue_repo: *64 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *68 - installation: *684 - organization: *685 - repository: *686 + blocking_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -131708,10 +132370,10 @@ webhooks: type: string enum: - assigned - assignee: *703 - enterprise: *683 - installation: *684 - issue: &710 + assignee: *707 + enterprise: *687 + installation: *688 + issue: &714 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -132523,11 +133185,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132544,7 +133206,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -132647,8 +133309,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -132728,8 +133390,8 @@ webhooks: type: string enum: - closed - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -133546,11 +134208,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133567,7 +134229,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -133813,8 +134475,8 @@ webhooks: required: - state - closed_at - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -133893,8 +134555,8 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134702,11 +135364,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134723,7 +135385,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -134825,8 +135487,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -134905,8 +135567,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135737,11 +136399,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135758,7 +136420,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -135839,7 +136501,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &708 + milestone: &712 title: Milestone description: A collection of related issues and pull requests. type: object @@ -135982,8 +136644,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -136082,8 +136744,8 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136895,11 +137557,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136913,7 +137575,7 @@ webhooks: timeline_url: type: string format: uri - type: *199 + type: *205 title: description: Title of the issue type: string @@ -137019,9 +137681,9 @@ webhooks: - active_lock_reason - body - reactions - label: *702 - organization: *685 - repository: *686 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -137101,8 +137763,8 @@ webhooks: type: string enum: - labeled - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137913,11 +138575,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137931,7 +138593,7 @@ webhooks: timeline_url: type: string format: uri - type: *199 + type: *205 title: description: Title of the issue type: string @@ -138037,9 +138699,9 @@ webhooks: - active_lock_reason - body - reactions - label: *702 - organization: *685 - repository: *686 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -138119,8 +138781,8 @@ webhooks: type: string enum: - locked - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138956,11 +139618,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138974,7 +139636,7 @@ webhooks: timeline_url: type: string format: uri - type: *199 + type: *205 title: description: Title of the issue type: string @@ -139057,8 +139719,8 @@ webhooks: format: uri user_view_type: type: string - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -139137,8 +139799,8 @@ webhooks: type: string enum: - milestoned - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139968,11 +140630,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139989,7 +140651,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -140069,9 +140731,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *708 - organization: *685 - repository: *686 + milestone: *712 + organization: *689 + repository: *690 sender: *4 required: - action @@ -140963,11 +141625,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141063,7 +141725,7 @@ webhooks: required: - login - id - type: *199 + type: *205 required: - id - number @@ -141544,8 +142206,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142357,11 +143019,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142378,7 +143040,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -142480,8 +143142,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -142561,9 +143223,9 @@ webhooks: type: string enum: - pinned - enterprise: *683 - installation: *684 - issue: &709 + enterprise: *687 + installation: *688 + issue: &713 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -143369,11 +144031,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143390,7 +144052,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -143492,8 +144154,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -143572,8 +144234,8 @@ webhooks: type: string enum: - reopened - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144407,11 +145069,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144508,9 +145170,9 @@ webhooks: format: uri user_view_type: type: string - type: *199 - organization: *685 - repository: *686 + type: *205 + organization: *689 + repository: *690 sender: *4 required: - action @@ -145399,11 +146061,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145420,7 +146082,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -146002,11 +146664,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *683 - installation: *684 - issue: *709 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *713 + organization: *689 + repository: *690 sender: *4 required: - action @@ -146086,12 +146748,12 @@ webhooks: type: string enum: - typed - enterprise: *683 - installation: *684 - issue: *710 - type: *199 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *714 + type: *205 + organization: *689 + repository: *690 sender: *4 required: - action @@ -146172,7 +146834,7 @@ webhooks: type: string enum: - unassigned - assignee: &734 + assignee: &738 title: User type: - object @@ -146244,11 +146906,11 @@ webhooks: required: - login - id - enterprise: *683 - installation: *684 - issue: *710 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *714 + organization: *689 + repository: *690 sender: *4 required: - action @@ -146327,12 +146989,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *683 - installation: *684 - issue: *710 - label: *702 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *714 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -146412,8 +147074,8 @@ webhooks: type: string enum: - unlocked - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147247,11 +147909,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *617 - issue_dependencies_summary: *618 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *619 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147268,7 +147930,7 @@ webhooks: title: description: Title of the issue type: string - type: *199 + type: *205 updated_at: type: string format: date-time @@ -147348,8 +148010,8 @@ webhooks: format: uri user_view_type: type: string - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147429,11 +148091,11 @@ webhooks: type: string enum: - unpinned - enterprise: *683 - installation: *684 - issue: *709 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *713 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147512,12 +148174,12 @@ webhooks: type: string enum: - untyped - enterprise: *683 - installation: *684 - issue: *710 - type: *199 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + issue: *714 + type: *205 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147597,11 +148259,11 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - label: *702 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147679,11 +148341,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - label: *702 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147793,11 +148455,11 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - label: *702 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + label: *706 + organization: *689 + repository: *690 sender: *4 required: - action @@ -147879,9 +148541,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *683 - installation: *684 - marketplace_purchase: &711 + enterprise: *687 + installation: *688 + marketplace_purchase: &715 title: Marketplace Purchase type: object required: @@ -147969,8 +148631,8 @@ webhooks: type: integer unit_count: type: integer - organization: *685 - previous_marketplace_purchase: &712 + organization: *689 + previous_marketplace_purchase: &716 title: Marketplace Purchase type: object properties: @@ -148054,7 +148716,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *686 + repository: *690 sender: *4 required: - action @@ -148134,10 +148796,10 @@ webhooks: - changed effective_date: type: string - enterprise: *683 - installation: *684 - marketplace_purchase: *711 - organization: *685 + enterprise: *687 + installation: *688 + marketplace_purchase: *715 + organization: *689 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148225,7 +148887,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *686 + repository: *690 sender: *4 required: - action @@ -148307,10 +148969,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *683 - installation: *684 - marketplace_purchase: *711 - organization: *685 + enterprise: *687 + installation: *688 + marketplace_purchase: *715 + organization: *689 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148396,7 +149058,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *686 + repository: *690 sender: *4 required: - action @@ -148477,8 +149139,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 marketplace_purchase: title: Marketplace Purchase type: object @@ -148564,9 +149226,9 @@ webhooks: type: integer unit_count: type: integer - organization: *685 - previous_marketplace_purchase: *712 - repository: *686 + organization: *689 + previous_marketplace_purchase: *716 + repository: *690 sender: *4 required: - action @@ -148646,12 +149308,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *683 - installation: *684 - marketplace_purchase: *711 - organization: *685 - previous_marketplace_purchase: *712 - repository: *686 + enterprise: *687 + installation: *688 + marketplace_purchase: *715 + organization: *689 + previous_marketplace_purchase: *716 + repository: *690 sender: *4 required: - action @@ -148753,11 +149415,11 @@ webhooks: type: string required: - to - enterprise: *683 - installation: *684 - member: *703 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + member: *707 + organization: *689 + repository: *690 sender: *4 required: - action @@ -148859,11 +149521,11 @@ webhooks: type: - string - 'null' - enterprise: *683 - installation: *684 - member: *703 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + member: *707 + organization: *689 + repository: *690 sender: *4 required: - action @@ -148942,11 +149604,11 @@ webhooks: type: string enum: - removed - enterprise: *683 - installation: *684 - member: *703 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + member: *707 + organization: *689 + repository: *690 sender: *4 required: - action @@ -149024,11 +149686,11 @@ webhooks: type: string enum: - added - enterprise: *683 - installation: *684 - member: *703 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + member: *707 + organization: *689 + repository: *690 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149106,7 +149768,7 @@ webhooks: required: - login - id - team: &713 + team: &717 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -149336,11 +149998,11 @@ webhooks: type: string enum: - removed - enterprise: *683 - installation: *684 - member: *703 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + member: *707 + organization: *689 + repository: *690 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149419,7 +150081,7 @@ webhooks: required: - login - id - team: *713 + team: *717 required: - action - scope @@ -149501,8 +150163,8 @@ webhooks: type: string enum: - checks_requested - installation: *684 - merge_group: &714 + installation: *688 + merge_group: &718 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -149521,15 +150183,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *398 + head_commit: *393 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -149615,10 +150277,10 @@ webhooks: - merged - invalidated - dequeued - installation: *684 - merge_group: *714 - organization: *685 - repository: *686 + installation: *688 + merge_group: *718 + organization: *689 + repository: *690 sender: *4 required: - action @@ -149691,7 +150353,7 @@ webhooks: type: string enum: - deleted - enterprise: *683 + enterprise: *687 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -149800,12 +150462,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *684 - organization: *685 + installation: *688 + organization: *689 repository: anyOf: - type: 'null' - - *686 + - *690 sender: *4 required: - action @@ -149885,11 +150547,11 @@ webhooks: type: string enum: - closed - enterprise: *683 - installation: *684 - milestone: *708 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + milestone: *712 + organization: *689 + repository: *690 sender: *4 required: - action @@ -149968,9 +150630,9 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - milestone: &715 + enterprise: *687 + installation: *688 + milestone: &719 title: Milestone description: A collection of related issues and pull requests. type: object @@ -150112,8 +150774,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150192,11 +150854,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - milestone: *708 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + milestone: *712 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150306,11 +150968,11 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - milestone: *708 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + milestone: *712 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150390,11 +151052,11 @@ webhooks: type: string enum: - opened - enterprise: *683 - installation: *684 - milestone: *715 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + milestone: *719 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150473,11 +151135,11 @@ webhooks: type: string enum: - blocked - blocked_user: *703 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + blocked_user: *707 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150556,11 +151218,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *703 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + blocked_user: *707 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150639,9 +151301,9 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - membership: &716 + enterprise: *687 + installation: *688 + membership: &720 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -150751,8 +151413,8 @@ webhooks: - role - organization_url - user - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150830,11 +151492,11 @@ webhooks: type: string enum: - member_added - enterprise: *683 - installation: *684 - membership: *716 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + membership: *720 + organization: *689 + repository: *690 sender: *4 required: - action @@ -150913,8 +151575,8 @@ webhooks: type: string enum: - member_invited - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -151036,10 +151698,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 - user: *703 + user: *707 required: - action - invitation @@ -151117,11 +151779,11 @@ webhooks: type: string enum: - member_removed - enterprise: *683 - installation: *684 - membership: *716 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + membership: *720 + organization: *689 + repository: *690 sender: *4 required: - action @@ -151208,11 +151870,11 @@ webhooks: properties: from: type: string - enterprise: *683 - installation: *684 - membership: *716 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + membership: *720 + organization: *689 + repository: *690 sender: *4 required: - action @@ -151288,9 +151950,9 @@ webhooks: type: string enum: - published - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 package: description: Information about the package. type: object @@ -151813,7 +152475,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &717 + items: &721 title: Ruby Gems metadata type: object properties: @@ -151910,7 +152572,7 @@ webhooks: - owner - package_version - registry - repository: *686 + repository: *690 sender: *4 required: - action @@ -151986,9 +152648,9 @@ webhooks: type: string enum: - updated - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 package: description: Information about the package. type: object @@ -152350,7 +153012,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *717 + items: *721 source_url: type: string format: uri @@ -152421,7 +153083,7 @@ webhooks: - owner - package_version - registry - repository: *686 + repository: *690 sender: *4 required: - action @@ -152602,12 +153264,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *683 + enterprise: *687 id: type: integer - installation: *684 - organization: *685 - repository: *686 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - id @@ -152684,7 +153346,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &718 + personal_access_token_request: &722 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -152834,10 +153496,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *683 - organization: *685 + enterprise: *687 + organization: *689 sender: *4 - installation: *684 + installation: *688 required: - action - personal_access_token_request @@ -152914,11 +153576,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *718 - enterprise: *683 - organization: *685 + personal_access_token_request: *722 + enterprise: *687 + organization: *689 sender: *4 - installation: *684 + installation: *688 required: - action - personal_access_token_request @@ -152994,11 +153656,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *718 - enterprise: *683 - organization: *685 + personal_access_token_request: *722 + enterprise: *687 + organization: *689 sender: *4 - installation: *684 + installation: *688 required: - action - personal_access_token_request @@ -153073,11 +153735,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *718 - organization: *685 - enterprise: *683 + personal_access_token_request: *722 + organization: *689 + enterprise: *687 sender: *4 - installation: *684 + installation: *688 required: - action - personal_access_token_request @@ -153182,7 +153844,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *719 + last_response: *723 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -153214,8 +153876,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 zen: description: Random string of GitHub zen. @@ -153460,10 +154122,10 @@ webhooks: - from required: - note - enterprise: *683 - installation: *684 - organization: *685 - project_card: &720 + enterprise: *687 + installation: *688 + organization: *689 + project_card: &724 title: Project Card type: object properties: @@ -153586,7 +154248,7 @@ webhooks: - creator - created_at - updated_at - repository: *686 + repository: *690 sender: *4 required: - action @@ -153667,11 +154329,11 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - project_card: *720 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project_card: *724 + repository: *690 sender: *4 required: - action @@ -153751,9 +154413,9 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 project_card: title: Project Card type: object @@ -153883,7 +154545,7 @@ webhooks: repository: anyOf: - type: 'null' - - *686 + - *690 sender: *4 required: - action @@ -153977,11 +154639,11 @@ webhooks: - from required: - note - enterprise: *683 - installation: *684 - organization: *685 - project_card: *720 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project_card: *724 + repository: *690 sender: *4 required: - action @@ -154075,9 +154737,9 @@ webhooks: - from required: - column_id - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 project_card: allOf: - title: Project Card @@ -154274,7 +154936,7 @@ webhooks: type: string required: - after_id - repository: *686 + repository: *690 sender: *4 required: - action @@ -154354,10 +155016,10 @@ webhooks: type: string enum: - closed - enterprise: *683 - installation: *684 - organization: *685 - project: &722 + enterprise: *687 + installation: *688 + organization: *689 + project: &726 title: Project type: object properties: @@ -154484,7 +155146,7 @@ webhooks: - creator - created_at - updated_at - repository: *686 + repository: *690 sender: *4 required: - action @@ -154564,10 +155226,10 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - project_column: &721 + enterprise: *687 + installation: *688 + organization: *689 + project_column: &725 title: Project Column type: object properties: @@ -154607,7 +155269,7 @@ webhooks: - name - created_at - updated_at - repository: *686 + repository: *690 sender: *4 required: - action @@ -154686,14 +155348,14 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - project_column: *721 + enterprise: *687 + installation: *688 + organization: *689 + project_column: *725 repository: anyOf: - type: 'null' - - *686 + - *690 sender: *4 required: - action @@ -154782,11 +155444,11 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - organization: *685 - project_column: *721 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project_column: *725 + repository: *690 sender: *4 required: - action @@ -154866,11 +155528,11 @@ webhooks: type: string enum: - moved - enterprise: *683 - installation: *684 - organization: *685 - project_column: *721 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project_column: *725 + repository: *690 sender: *4 required: - action @@ -154950,11 +155612,11 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - project: *722 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project: *726 + repository: *690 sender: *4 required: - action @@ -155034,14 +155696,14 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - project: *722 + enterprise: *687 + installation: *688 + organization: *689 + project: *726 repository: anyOf: - type: 'null' - - *686 + - *690 sender: *4 required: - action @@ -155142,11 +155804,11 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - organization: *685 - project: *722 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project: *726 + repository: *690 sender: *4 required: - action @@ -155225,11 +155887,11 @@ webhooks: type: string enum: - reopened - enterprise: *683 - installation: *684 - organization: *685 - project: *722 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + project: *726 + repository: *690 sender: *4 required: - action @@ -155310,9 +155972,9 @@ webhooks: type: string enum: - closed - installation: *684 - organization: *685 - projects_v2: *233 + installation: *688 + organization: *689 + projects_v2: *239 sender: *4 required: - action @@ -155393,9 +156055,9 @@ webhooks: type: string enum: - created - installation: *684 - organization: *685 - projects_v2: *233 + installation: *688 + organization: *689 + projects_v2: *239 sender: *4 required: - action @@ -155476,9 +156138,9 @@ webhooks: type: string enum: - deleted - installation: *684 - organization: *685 - projects_v2: *233 + installation: *688 + organization: *689 + projects_v2: *239 sender: *4 required: - action @@ -155599,9 +156261,9 @@ webhooks: type: string to: type: string - installation: *684 - organization: *685 - projects_v2: *233 + installation: *688 + organization: *689 + projects_v2: *239 sender: *4 required: - action @@ -155684,7 +156346,7 @@ webhooks: type: string enum: - archived - changes: &726 + changes: &730 type: object properties: archived_at: @@ -155700,9 +156362,9 @@ webhooks: - string - 'null' format: date-time - installation: *684 - organization: *685 - projects_v2_item: &723 + installation: *688 + organization: *689 + projects_v2_item: &727 title: Projects v2 Item description: An item belonging to a project type: object @@ -155720,7 +156382,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *240 + content_type: *246 creator: *4 created_at: type: string @@ -155842,9 +156504,9 @@ webhooks: - 'null' to: type: string - installation: *684 - organization: *685 - projects_v2_item: *723 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -155926,9 +156588,9 @@ webhooks: type: string enum: - created - installation: *684 - organization: *685 - projects_v2_item: *723 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -156009,9 +156671,9 @@ webhooks: type: string enum: - deleted - installation: *684 - organization: *685 - projects_v2_item: *723 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -156116,7 +156778,7 @@ webhooks: oneOf: - type: string - type: integer - - &724 + - &728 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -156140,7 +156802,7 @@ webhooks: required: - id - name - - &725 + - &729 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -156180,8 +156842,8 @@ webhooks: oneOf: - type: string - type: integer - - *724 - - *725 + - *728 + - *729 type: - 'null' - string @@ -156204,9 +156866,9 @@ webhooks: - 'null' required: - body - installation: *684 - organization: *685 - projects_v2_item: *723 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -156303,9 +156965,9 @@ webhooks: type: - string - 'null' - installation: *684 - organization: *685 - projects_v2_item: *723 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -156388,10 +157050,10 @@ webhooks: type: string enum: - restored - changes: *726 - installation: *684 - organization: *685 - projects_v2_item: *723 + changes: *730 + installation: *688 + organization: *689 + projects_v2_item: *727 sender: *4 required: - action @@ -156473,9 +157135,9 @@ webhooks: type: string enum: - reopened - installation: *684 - organization: *685 - projects_v2: *233 + installation: *688 + organization: *689 + projects_v2: *239 sender: *4 required: - action @@ -156556,9 +157218,9 @@ webhooks: type: string enum: - created - installation: *684 - organization: *685 - projects_v2_status_update: *727 + installation: *688 + organization: *689 + projects_v2_status_update: *731 sender: *4 required: - action @@ -156639,9 +157301,9 @@ webhooks: type: string enum: - deleted - installation: *684 - organization: *685 - projects_v2_status_update: *727 + installation: *688 + organization: *689 + projects_v2_status_update: *731 sender: *4 required: - action @@ -156787,9 +157449,9 @@ webhooks: - string - 'null' format: date - installation: *684 - organization: *685 - projects_v2_status_update: *727 + installation: *688 + organization: *689 + projects_v2_status_update: *731 sender: *4 required: - action @@ -156860,10 +157522,10 @@ webhooks: title: public event type: object properties: - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - repository @@ -156940,13 +157602,13 @@ webhooks: type: string enum: - assigned - assignee: *703 - enterprise: *683 - installation: *684 - number: &728 + assignee: *707 + enterprise: *687 + installation: *688 + number: &732 description: The pull request number. type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -159295,7 +159957,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -159377,11 +160039,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -161723,7 +162385,7 @@ webhooks: - draft reason: type: string - repository: *686 + repository: *690 sender: *4 required: - action @@ -161805,11 +162467,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -164151,7 +164813,7 @@ webhooks: - draft reason: type: string - repository: *686 + repository: *690 sender: *4 required: - action @@ -164233,13 +164895,13 @@ webhooks: type: string enum: - closed - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: &729 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: &733 allOf: - - *547 + - *544 - type: object properties: allow_auto_merge: @@ -164301,7 +164963,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *686 + repository: *690 sender: *4 required: - action @@ -164382,12 +165044,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: *729 - repository: *686 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: *733 + repository: *690 sender: *4 required: - action @@ -164467,11 +165129,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *683 - milestone: *238 - number: *728 - organization: *685 - pull_request: &730 + enterprise: *687 + milestone: *244 + number: *732 + organization: *689 + pull_request: &734 title: Pull Request type: object properties: @@ -166798,7 +167460,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -166877,11 +167539,11 @@ webhooks: type: string enum: - dequeued - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -169227,7 +169889,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *686 + repository: *690 sender: *4 required: - action @@ -169351,12 +170013,12 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: *729 - repository: *686 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: *733 + repository: *690 sender: *4 required: - action @@ -169436,11 +170098,11 @@ webhooks: type: string enum: - enqueued - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -171771,7 +172433,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -171851,11 +172513,11 @@ webhooks: type: string enum: - labeled - enterprise: *683 - installation: *684 - label: *702 - number: *728 - organization: *685 + enterprise: *687 + installation: *688 + label: *706 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -174203,7 +174865,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -174284,10 +174946,10 @@ webhooks: type: string enum: - locked - enterprise: *683 - installation: *684 - number: *728 - organization: *685 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -176633,7 +177295,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -176713,12 +177375,12 @@ webhooks: type: string enum: - milestoned - enterprise: *683 - milestone: *238 - number: *728 - organization: *685 - pull_request: *730 - repository: *686 + enterprise: *687 + milestone: *244 + number: *732 + organization: *689 + pull_request: *734 + repository: *690 sender: *4 required: - action @@ -176797,12 +177459,12 @@ webhooks: type: string enum: - opened - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: *729 - repository: *686 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: *733 + repository: *690 sender: *4 required: - action @@ -176883,12 +177545,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: *729 - repository: *686 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: *733 + repository: *690 sender: *4 required: - action @@ -176968,12 +177630,12 @@ webhooks: type: string enum: - reopened - enterprise: *683 - installation: *684 - number: *728 - organization: *685 - pull_request: *729 - repository: *686 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 + pull_request: *733 + repository: *690 sender: *4 required: - action @@ -177348,9 +178010,9 @@ webhooks: - start_side - side - reactions - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: type: object properties: @@ -179580,7 +180242,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *686 + repository: *690 sender: *4 required: - action @@ -179660,7 +180322,7 @@ webhooks: type: string enum: - deleted - comment: &732 + comment: &736 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -179953,9 +180615,9 @@ webhooks: - start_side - side - reactions - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: type: object properties: @@ -182173,7 +182835,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *686 + repository: *690 sender: *4 required: - action @@ -182253,11 +182915,11 @@ webhooks: type: string enum: - edited - changes: *731 - comment: *732 - enterprise: *683 - installation: *684 - organization: *685 + changes: *735 + comment: *736 + enterprise: *687 + installation: *688 + organization: *689 pull_request: type: object properties: @@ -184478,7 +185140,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *686 + repository: *690 sender: *4 required: - action @@ -184559,9 +185221,9 @@ webhooks: type: string enum: - dismissed - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: title: Simple Pull Request type: object @@ -186794,7 +187456,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *686 + repository: *690 review: description: The review that was affected. type: object @@ -187045,9 +187707,9 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: title: Simple Pull Request type: object @@ -189161,8 +189823,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *686 - review: &733 + repository: *690 + review: &737 description: The review that was affected. type: object properties: @@ -189400,12 +190062,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: description: The pull request number. type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -191752,7 +192414,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 requested_reviewer: title: User type: @@ -191838,12 +192500,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: description: The pull request number. type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -194197,7 +194859,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194392,12 +195054,12 @@ webhooks: type: string enum: - review_requested - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: description: The pull request number. type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -196746,7 +197408,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 requested_reviewer: title: User type: @@ -196833,12 +197495,12 @@ webhooks: type: string enum: - review_requested - enterprise: *683 - installation: *684 + enterprise: *687 + installation: *688 number: description: The pull request number. type: integer - organization: *685 + organization: *689 pull_request: title: Pull Request type: object @@ -199178,7 +199840,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199362,9 +200024,9 @@ webhooks: type: string enum: - submitted - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: title: Simple Pull Request type: object @@ -201600,8 +202262,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *686 - review: *733 + repository: *690 + review: *737 sender: *4 required: - action @@ -201681,9 +202343,9 @@ webhooks: type: string enum: - resolved - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: title: Simple Pull Request type: object @@ -203814,7 +204476,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *686 + repository: *690 sender: *4 thread: type: object @@ -204211,9 +204873,9 @@ webhooks: type: string enum: - unresolved - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 pull_request: title: Simple Pull Request type: object @@ -206327,7 +206989,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *686 + repository: *690 sender: *4 thread: type: object @@ -206726,10 +207388,10 @@ webhooks: type: string before: type: string - enterprise: *683 - installation: *684 - number: *728 - organization: *685 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -209064,7 +209726,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -209146,11 +209808,11 @@ webhooks: type: string enum: - unassigned - assignee: *734 - enterprise: *683 - installation: *684 - number: *728 - organization: *685 + assignee: *738 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -211500,7 +212162,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -211579,11 +212241,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *683 - installation: *684 - label: *702 - number: *728 - organization: *685 + enterprise: *687 + installation: *688 + label: *706 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -213922,7 +214584,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -214003,10 +214665,10 @@ webhooks: type: string enum: - unlocked - enterprise: *683 - installation: *684 - number: *728 - organization: *685 + enterprise: *687 + installation: *688 + number: *732 + organization: *689 pull_request: title: Pull Request type: object @@ -216335,7 +216997,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *686 + repository: *690 sender: *4 required: - action @@ -216538,7 +217200,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *683 + enterprise: *687 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -216633,8 +217295,8 @@ webhooks: - url - author - committer - installation: *684 - organization: *685 + installation: *688 + organization: *689 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -217222,9 +217884,9 @@ webhooks: type: string enum: - published - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 registry_package: type: object properties: @@ -217701,7 +218363,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *717 + items: *721 summary: type: string tag_name: @@ -217757,7 +218419,7 @@ webhooks: - owner - package_version - registry - repository: *686 + repository: *690 sender: *4 required: - action @@ -217835,9 +218497,9 @@ webhooks: type: string enum: - updated - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 registry_package: type: object properties: @@ -218149,7 +218811,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *717 + items: *721 summary: type: string tag_name: @@ -218199,7 +218861,7 @@ webhooks: - owner - package_version - registry - repository: *686 + repository: *690 sender: *4 required: - action @@ -218276,10 +218938,10 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - release: &735 + enterprise: *687 + installation: *688 + organization: *689 + release: &739 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -218610,7 +219272,7 @@ webhooks: - updated_at - zipball_url - body - repository: *686 + repository: *690 sender: *4 required: - action @@ -218687,11 +219349,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - release: *735 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + release: *739 + repository: *690 sender: *4 required: - action @@ -218808,11 +219470,11 @@ webhooks: type: boolean required: - to - enterprise: *683 - installation: *684 - organization: *685 - release: *735 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + release: *739 + repository: *690 sender: *4 required: - action @@ -218890,9 +219552,9 @@ webhooks: type: string enum: - prereleased - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -219228,7 +219890,7 @@ webhooks: - string - 'null' format: uri - repository: *686 + repository: *690 sender: *4 required: - action @@ -219304,10 +219966,10 @@ webhooks: type: string enum: - published - enterprise: *683 - installation: *684 - organization: *685 - release: &736 + enterprise: *687 + installation: *688 + organization: *689 + release: &740 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219640,7 +220302,7 @@ webhooks: - string - 'null' format: uri - repository: *686 + repository: *690 sender: *4 required: - action @@ -219716,11 +220378,11 @@ webhooks: type: string enum: - released - enterprise: *683 - installation: *684 - organization: *685 - release: *735 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + release: *739 + repository: *690 sender: *4 required: - action @@ -219796,11 +220458,11 @@ webhooks: type: string enum: - unpublished - enterprise: *683 - installation: *684 - organization: *685 - release: *736 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + release: *740 + repository: *690 sender: *4 required: - action @@ -219876,11 +220538,11 @@ webhooks: type: string enum: - published - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - repository_advisory: *603 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + repository_advisory: *608 sender: *4 required: - action @@ -219956,11 +220618,11 @@ webhooks: type: string enum: - reported - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - repository_advisory: *603 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + repository_advisory: *608 sender: *4 required: - action @@ -220036,10 +220698,10 @@ webhooks: type: string enum: - archived - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220116,10 +220778,10 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220197,10 +220859,10 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220285,10 +220947,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220403,10 +221065,10 @@ webhooks: - 'null' items: type: string - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220478,10 +221140,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 status: type: string @@ -220562,10 +221224,10 @@ webhooks: type: string enum: - privatized - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220642,10 +221304,10 @@ webhooks: type: string enum: - publicized - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220739,10 +221401,10 @@ webhooks: - name required: - repository - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -220822,11 +221484,11 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - repository_ruleset: *276 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + repository_ruleset: *281 sender: *4 required: - action @@ -220904,11 +221566,11 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - repository_ruleset: *276 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + repository_ruleset: *281 sender: *4 required: - action @@ -220986,11 +221648,11 @@ webhooks: type: string enum: - edited - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - repository_ruleset: *276 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + repository_ruleset: *281 changes: type: object properties: @@ -221009,16 +221671,16 @@ webhooks: properties: added: type: array - items: *251 + items: *256 deleted: type: array - items: *251 + items: *256 updated: type: array items: type: object properties: - condition: *251 + condition: *256 changes: type: object properties: @@ -221051,16 +221713,16 @@ webhooks: properties: added: type: array - items: *568 + items: *565 deleted: type: array - items: *568 + items: *565 updated: type: array items: type: object properties: - rule: *568 + rule: *565 changes: type: object properties: @@ -221297,10 +221959,10 @@ webhooks: - from required: - owner - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -221378,10 +222040,10 @@ webhooks: type: string enum: - unarchived - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -221459,7 +222121,7 @@ webhooks: type: string enum: - create - alert: &737 + alert: &741 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -221583,10 +222245,10 @@ webhooks: type: string enum: - open - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -221796,10 +222458,10 @@ webhooks: type: string enum: - dismissed - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -221877,11 +222539,11 @@ webhooks: type: string enum: - reopen - alert: *737 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + alert: *741 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222083,10 +222745,10 @@ webhooks: enum: - fixed - open - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222164,17 +222826,17 @@ webhooks: type: string enum: - created - alert: &738 + alert: &742 type: object properties: - number: *52 - created_at: *53 + number: *151 + created_at: *152 updated_at: anyOf: - type: 'null' - - *54 - url: *55 - html_url: *56 + - *153 + url: *154 + html_url: *155 locations_url: type: string format: uri @@ -222278,10 +222940,10 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222362,11 +223024,11 @@ webhooks: type: string enum: - created - alert: *738 - installation: *684 - location: *739 - organization: *685 - repository: *686 + alert: *742 + installation: *688 + location: *743 + organization: *689 + repository: *690 sender: *4 required: - location @@ -222604,11 +223266,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *738 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + alert: *742 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222686,11 +223348,11 @@ webhooks: type: string enum: - reopened - alert: *738 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + alert: *742 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222768,11 +223430,11 @@ webhooks: type: string enum: - resolved - alert: *738 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + alert: *742 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222850,11 +223512,11 @@ webhooks: type: string enum: - validated - alert: *738 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + alert: *742 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -222984,10 +223646,10 @@ webhooks: - organization - enterprise - - repository: *686 - enterprise: *683 - installation: *684 - organization: *685 + repository: *690 + enterprise: *687 + installation: *688 + organization: *689 sender: *4 required: - action @@ -223065,11 +223727,11 @@ webhooks: type: string enum: - published - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - security_advisory: &740 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + security_advisory: &744 description: The details of the security advisory, including summary, description, and severity. type: object @@ -223255,11 +223917,11 @@ webhooks: type: string enum: - updated - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 - security_advisory: *740 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 + security_advisory: *744 sender: *4 required: - action @@ -223332,10 +223994,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -223521,11 +224183,11 @@ webhooks: from: type: object properties: - security_and_analysis: *250 - enterprise: *683 - installation: *684 - organization: *685 - repository: *322 + security_and_analysis: *255 + enterprise: *687 + installation: *688 + organization: *689 + repository: *317 sender: *4 required: - changes @@ -223603,12 +224265,12 @@ webhooks: type: string enum: - cancelled - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: &741 + sponsorship: &745 type: object properties: created_at: @@ -223913,12 +224575,12 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: *741 + sponsorship: *745 required: - action - sponsorship @@ -224006,12 +224668,12 @@ webhooks: type: string required: - from - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: *741 + sponsorship: *745 required: - action - changes @@ -224088,17 +224750,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &742 + effective_date: &746 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: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: *741 + sponsorship: *745 required: - action - sponsorship @@ -224172,7 +224834,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &743 + changes: &747 type: object properties: tier: @@ -224216,13 +224878,13 @@ webhooks: - from required: - tier - effective_date: *742 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + effective_date: *746 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: *741 + sponsorship: *745 required: - action - changes @@ -224299,13 +224961,13 @@ webhooks: type: string enum: - tier_changed - changes: *743 - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + changes: *747 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - sponsorship: *741 + sponsorship: *745 required: - action - changes @@ -224379,10 +225041,10 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224466,10 +225128,10 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224903,15 +225565,15 @@ webhooks: type: - string - 'null' - enterprise: *683 + enterprise: *687 id: description: The unique identifier of the status. type: integer - installation: *684 + installation: *688 name: type: string - organization: *685 - repository: *686 + organization: *689 + repository: *690 sender: *4 sha: description: The Commit SHA. @@ -225021,15 +225683,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *68 - parent_issue_repo: *66 + parent_issue: *66 + parent_issue_repo: *64 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *68 - installation: *684 - organization: *685 - repository: *686 + sub_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -225113,15 +225775,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *68 - parent_issue_repo: *66 + parent_issue: *66 + parent_issue_repo: *64 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *68 - installation: *684 - organization: *685 - repository: *686 + sub_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -225205,15 +225867,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *68 - sub_issue_repo: *66 + sub_issue: *66 + sub_issue_repo: *64 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *68 - installation: *684 - organization: *685 - repository: *686 + parent_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -225297,15 +225959,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *68 - sub_issue_repo: *66 + sub_issue: *66 + sub_issue_repo: *64 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *68 - installation: *684 - organization: *685 - repository: *686 + parent_issue: *66 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -225382,12 +226044,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - team: &744 + team: &748 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -225617,9 +226279,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 repository: title: Repository description: A git repository @@ -226089,7 +226751,7 @@ webhooks: - topics - visibility sender: *4 - team: *744 + team: *748 required: - action - team @@ -226165,9 +226827,9 @@ webhooks: type: string enum: - created - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 repository: title: Repository description: A git repository @@ -226637,7 +227299,7 @@ webhooks: - topics - visibility sender: *4 - team: *744 + team: *748 required: - action - team @@ -226714,9 +227376,9 @@ webhooks: type: string enum: - deleted - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 repository: title: Repository description: A git repository @@ -227186,7 +227848,7 @@ webhooks: - topics - visibility sender: *4 - team: *744 + team: *748 required: - action - team @@ -227330,9 +227992,9 @@ webhooks: - from required: - permissions - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 repository: title: Repository description: A git repository @@ -227802,7 +228464,7 @@ webhooks: - topics - visibility sender: *4 - team: *744 + team: *748 required: - action - changes @@ -227880,9 +228542,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *683 - installation: *684 - organization: *685 + enterprise: *687 + installation: *688 + organization: *689 repository: title: Repository description: A git repository @@ -228352,7 +229014,7 @@ webhooks: - topics - visibility sender: *4 - team: *744 + team: *748 required: - action - team @@ -228428,10 +229090,10 @@ webhooks: type: string enum: - started - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 required: - action @@ -228504,17 +229166,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *683 + enterprise: *687 inputs: type: - object - 'null' additionalProperties: true - installation: *684 - organization: *685 + installation: *688 + organization: *689 ref: type: string - repository: *686 + repository: *690 sender: *4 workflow: type: string @@ -228596,10 +229258,10 @@ webhooks: type: string enum: - completed - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 workflow_job: allOf: @@ -228855,7 +229517,7 @@ webhooks: type: string required: - conclusion - deployment: *467 + deployment: *462 required: - action - repository @@ -228934,10 +229596,10 @@ webhooks: type: string enum: - in_progress - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 workflow_job: allOf: @@ -229219,7 +229881,7 @@ webhooks: required: - status - steps - deployment: *467 + deployment: *462 required: - action - repository @@ -229298,10 +229960,10 @@ webhooks: type: string enum: - queued - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 workflow_job: type: object @@ -229447,7 +230109,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *467 + deployment: *462 required: - action - repository @@ -229526,10 +230188,10 @@ webhooks: type: string enum: - waiting - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 workflow_job: type: object @@ -229676,7 +230338,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *467 + deployment: *462 required: - action - repository @@ -229756,12 +230418,12 @@ webhooks: type: string enum: - completed - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - workflow: *698 + workflow: *702 workflow_run: title: Workflow Run type: object @@ -230780,12 +231442,12 @@ webhooks: type: string enum: - in_progress - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - workflow: *698 + workflow: *702 workflow_run: title: Workflow Run type: object @@ -231789,12 +232451,12 @@ webhooks: type: string enum: - requested - enterprise: *683 - installation: *684 - organization: *685 - repository: *686 + enterprise: *687 + installation: *688 + organization: *689 + repository: *690 sender: *4 - workflow: *698 + workflow: *702 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 8d97d0fbd..ca8e736c5 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/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." @@ -5623,6 +5627,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.", @@ -5821,6 +5833,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.", @@ -6730,6 +6751,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.", @@ -6928,6 +6957,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.", @@ -7610,6 +7648,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.", @@ -7808,6 +7854,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.", @@ -8055,6 +8110,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.", @@ -8253,6 +8316,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.", @@ -10358,6 +10430,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.", @@ -10556,6 +10636,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.", @@ -11497,6 +11586,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.", @@ -11695,6 +11792,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.", @@ -12500,6 +12606,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.", @@ -12698,6 +12812,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.", @@ -13206,6 +13329,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.", @@ -13404,6 +13535,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.", @@ -19279,6 +19419,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -19409,6 +19556,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -19549,6 +19700,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -19569,6 +19727,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": [ @@ -19665,6 +19828,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -19795,6 +19965,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -19850,17 +20024,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": [ { @@ -19891,15 +20065,15 @@ "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", + "type": "integer", "examples": [ - "ubuntu-20.04" + 1 ] }, "platform": { @@ -19909,36 +20083,58 @@ "linux-x64" ] }, - "size_gb": { - "description": "Image size in GB.", + "total_versions_size": { + "description": "Total size of all the image versions in GB.", "type": "integer", "examples": [ - 86 + 200 ] }, - "display_name": { + "name": { "description": "Display name for this image.", "type": "string", "examples": [ - 20.04 + "CustomImage" ] }, "source": { "description": "The image provider.", "type": "string", - "enum": [ - "github", - "partner", + "examples": [ "custom" ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "Ready" + ] } }, "required": [ "id", "platform", - "size_gb", - "display_name", - "source" + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" ] } } @@ -19947,11 +20143,157 @@ "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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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" } } } @@ -19965,21 +20307,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.", @@ -19999,63 +20393,61 @@ "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", "examples": [ - "ubuntu-20.04" + "1.0.0" ] }, - "platform": { - "description": "The operating system of the image.", + "state": { + "description": "The state of image version.", "type": "string", "examples": [ - "linux-x64" + "Ready" ] }, "size_gb": { - "description": "Image size in GB.", + "description": "Image version size in GB.", "type": "integer", "examples": [ - 86 + 30 ] }, - "display_name": { - "description": "Display name for this image.", + "created_on": { + "description": "The creation date time of the image version.", "type": "string", "examples": [ - 20.04 + "2024-11-09T23:39:01Z" ] }, - "source": { - "description": "The image provider.", + "state_details": { + "description": "The image version status details.", "type": "string", - "enum": [ - "github", - "partner", - "custom" + "examples": [ + "None" ] } }, "required": [ - "id", - "platform", + "version", + "state", "size_gb", - "display_name", - "source" + "created_on", + "state_details" ] } } @@ -20064,11 +20456,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" + } + ] } } } @@ -20084,17 +20486,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": [ { @@ -20105,6 +20507,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": { @@ -20113,45 +20534,61 @@ "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.", - "examples": [ - 50 - ] - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "examples": [ - 17 - ] - } - }, - "required": [ - "maximum", - "current_usage" + "version": { + "description": "The version of image.", + "type": "string", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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" } } } @@ -20165,19 +20602,389 @@ "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", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 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", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 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.", + "examples": [ + 50 + ] + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "examples": [ + 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": [ { @@ -20444,6 +21251,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -20574,6 +21388,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -20689,6 +21507,13 @@ "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", + "null" + ] } } }, @@ -20775,6 +21600,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -20905,6 +21737,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -21060,6 +21896,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -21190,6 +22033,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -29414,6 +30261,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.", @@ -29612,6 +30467,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.", @@ -30252,6 +31116,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.", @@ -30450,6 +31322,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.", @@ -31310,6 +32191,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.", @@ -31508,6 +32397,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.", @@ -32765,6 +33663,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.", @@ -32963,6 +33869,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.", @@ -45110,6 +46025,658 @@ } } }, + "/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", + "examples": [ + "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", + "examples": [ + "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", @@ -45251,29 +46818,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).\"", @@ -48924,17 +50468,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": [ { @@ -48955,138 +50499,149 @@ "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" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "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" }, - { - "type": "array", + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], "items": { - "type": "string" - } + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" + } }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 + { + "type": "object", + "properties": { + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } }, - "maxItems": 200, - "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", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" + "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" + } + ] + } } } } @@ -49149,19 +50704,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": [ { @@ -49183,106 +50738,1936 @@ "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" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "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" }, - { - "type": "array", + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], "items": { - "type": "string" - } + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" + } }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 + { + "type": "object", + "properties": { + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } }, - "maxItems": 200, - "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", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property.", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property.", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property." + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property.", + "examples": [ + "enterprise_actors" + ] + } + }, + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "examples": [ + 1296269 + ] + }, + "organization_login": { + "type": "string", + "examples": [ + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" ] }, "minItems": 1, @@ -50591,72 +53976,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": [ @@ -50667,30 +54386,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": [ @@ -50703,62 +54414,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" ] }, { @@ -50824,29 +54480,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" ] }, { @@ -54766,36 +58467,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" ] }, { @@ -54911,29 +58838,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" ] }, { @@ -54999,29 +58971,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" ] }, { @@ -59938,7 +63955,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "secret-scanning", "subcategory": "secret-scanning" @@ -60968,6 +64985,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": { @@ -62886,7 +66916,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" ], @@ -63069,7 +67099,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -63077,7 +67107,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -63085,7 +67115,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -64617,6 +68647,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": { "type": [ "string", @@ -66167,6 +70207,876 @@ } } }, + "/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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", @@ -66413,6 +71323,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": { "type": [ "string", @@ -114537,10 +119457,391 @@ } } }, + "/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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" ], @@ -114684,7 +119985,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -114692,7 +119993,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -114700,7 +120001,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -117275,6 +122576,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -117405,6 +122713,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -117545,6 +122857,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -117563,6 +122882,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": [ @@ -117660,6 +122984,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -117790,6 +123121,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -117845,6 +123180,639 @@ } } }, + "/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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", @@ -118439,6 +124407,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -118569,6 +124544,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -118684,6 +124663,13 @@ "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", + "null" + ] } } }, @@ -118770,6 +124756,309 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "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", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "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, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + 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", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + }, + "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", + "examples": [ + 5 + ] + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 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", + "examples": [ + "latest" + ] } }, "required": [ @@ -118900,291 +125189,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] - } - }, - "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", - "examples": [ - 5 - ] }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "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", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "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, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "image_gen": { "type": "boolean", - "examples": [ - 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", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -125175,6 +131183,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -125305,6 +131320,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -135677,6 +141696,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", @@ -138601,7 +144724,10 @@ }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", - "type": "array", + "type": [ + "array", + "null" + ], "minItems": 1, "items": { "type": "object", @@ -138635,8 +144761,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -158163,29 +164300,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).\"", @@ -180277,6 +186391,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.", @@ -180475,6 +186597,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.", @@ -181399,6 +187530,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.", @@ -181597,6 +187736,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.", @@ -217689,17 +223837,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } }, @@ -226675,17 +232827,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -405202,16 +411358,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).\"", @@ -405239,29 +411385,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": { @@ -449740,6 +455863,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.", @@ -449938,6 +456069,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.", @@ -631363,7 +637503,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" ], @@ -724555,6 +730695,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.", @@ -724753,6 +730901,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.", @@ -797553,6 +803710,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.", @@ -797751,6 +803916,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.", @@ -805632,17 +811806,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -814591,17 +820769,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -843270,7 +849452,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" ], @@ -843401,7 +849583,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -843409,7 +849591,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -843417,7 +849599,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -1052687,6 +1058869,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.", @@ -1052885,6 +1059075,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.", @@ -1055769,6 +1061968,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.", @@ -1055967,6 +1062174,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.", @@ -1058756,6 +1064972,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.", @@ -1058954,6 +1065178,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.", @@ -1061743,6 +1067976,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.", @@ -1061941,6 +1068182,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.", @@ -1064864,6 +1071114,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.", @@ -1065062,6 +1071320,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.", @@ -1067992,6 +1074259,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.", @@ -1068190,6 +1074465,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.", @@ -1073115,6 +1079399,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.", @@ -1073313,6 +1079605,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.", @@ -1239500,6 +1245801,1944 @@ } } }, + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index f0616924a..22744cd35 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/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 - - &97 + - &102 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 - - &98 + - &103 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 - - &99 + - &104 name: direction description: The direction to sort the results by. in: query @@ -703,7 +705,7 @@ paths: required: - vector_string - score - cvss_severities: &111 + cvss_severities: &121 type: - object - 'null' @@ -750,7 +752,7 @@ paths: required: - vector_string - score - epss: &112 + epss: &122 type: - object - 'null' @@ -913,7 +915,7 @@ paths: - subscriptions_url - type - url - type: &397 + type: &414 type: string description: The type of credit the user is receiving. enum: @@ -1046,7 +1048,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &224 + schema: &242 title: Validation Error Simple description: Validation Error Simple type: object @@ -1079,7 +1081,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: - - &713 + - &732 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1664,7 +1666,7 @@ paths: schema: type: integer default: 30 - - &309 + - &327 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 @@ -1680,7 +1682,7 @@ paths: application/json: schema: type: array - items: &310 + items: &328 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1776,7 +1778,7 @@ paths: - installation_id - repository_id examples: - default: &311 + default: &329 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1808,7 +1810,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &723 + schema: &742 title: Scim Error description: Scim Error type: object @@ -1839,7 +1841,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &223 + schema: &241 title: Validation Error description: Validation Error type: object @@ -1911,7 +1913,7 @@ paths: description: Response content: application/json: - schema: &312 + schema: &330 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2046,7 +2048,7 @@ paths: - request - response examples: - default: &313 + default: &331 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2250,7 +2252,7 @@ paths: parameters: - *17 - *19 - - &189 + - &206 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) @@ -2504,6 +2506,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 @@ -2684,6 +2694,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 @@ -2858,7 +2877,7 @@ paths: application/json: schema: *20 examples: - default: &77 + default: &82 value: id: 1 account: @@ -3009,7 +3028,7 @@ paths: - selected repositories: type: array - items: &67 + items: &72 title: Repository description: A repository on GitHub. type: object @@ -3036,7 +3055,7 @@ paths: license: anyOf: - type: 'null' - - &186 + - &203 title: License Simple description: License Simple type: object @@ -7785,7 +7804,7 @@ paths: description: Response content: application/json: - schema: &225 + schema: &243 type: object properties: total_active_caches_count: @@ -7800,7 +7819,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &226 + default: &244 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7895,12 +7914,18 @@ paths: - github - partner - custom + version: + description: The image version of the hosted runner + pool. + type: string + examples: + - latest required: - id - size_gb - display_name - source - machine_size_details: &45 + machine_size_details: &50 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -7996,6 +8021,10 @@ paths: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled + for the hosted runners. required: - id - name @@ -8005,7 +8034,7 @@ paths: - public_ip_enabled - platform examples: - default: &227 + default: &245 value: total_count: 2 runners: @@ -8094,6 +8123,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -8113,6 +8148,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 @@ -8135,7 +8175,7 @@ paths: application/json: schema: *42 examples: - default: &46 + default: &51 value: id: 5 name: My hosted ubuntu runner @@ -8162,6 +8202,322 @@ 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: + - *39 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: &43 + 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 + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with + the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the + image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with + the image. + type: string + examples: + - Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + examples: + default: &45 + 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: + - *39 + - &44 + 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: *43 + examples: + default: &246 + 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: + - *39 + - *44 + 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: + - *44 + - *39 + 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: &46 + 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 + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - None + required: + - version + - state + - size_gb + - created_on + - state_details + examples: + default: *45 + 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: + - *39 + - *44 + - &47 + 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: *46 + examples: + default: &247 + 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: + - *39 + - *44 + - *47 + 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 @@ -8190,7 +8546,7 @@ paths: type: integer images: type: array - items: &43 + items: &48 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -8230,7 +8586,7 @@ paths: - display_name - source examples: - default: &44 + default: &49 value: id: ubuntu-20.04 platform: linux-x64 @@ -8270,9 +8626,9 @@ paths: type: integer images: type: array - items: *43 + items: *48 examples: - default: *44 + default: *49 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8295,7 +8651,7 @@ paths: description: Response content: application/json: - schema: &228 + schema: &248 type: object properties: public_ips: @@ -8322,7 +8678,7 @@ paths: required: - public_ips examples: - default: &229 + default: &249 value: public_ips: current_usage: 17 @@ -8360,9 +8716,9 @@ paths: type: integer machine_specs: type: array - items: *45 + items: *50 examples: - default: &230 + default: &250 value: id: 4-core cpu_cores: 4 @@ -8430,7 +8786,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise parameters: - *39 - - &47 + - &52 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -8444,7 +8800,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 headers: Link: *41 x-github: @@ -8465,7 +8821,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise parameters: - *39 - - *47 + - *52 requestBody: required: true content: @@ -8491,6 +8847,12 @@ 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 + - 'null' examples: default: value: @@ -8505,7 +8867,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -8522,7 +8884,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise parameters: - *39 - - *47 + - *52 responses: '202': description: Response @@ -8530,7 +8892,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8599,7 +8961,7 @@ paths: schema: type: object properties: - enabled_organizations: &48 + enabled_organizations: &53 type: string description: The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. @@ -8612,7 +8974,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: &49 + allowed_actions: &54 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -8620,12 +8982,12 @@ paths: - all - local_only - selected - selected_actions_url: &233 + selected_actions_url: &253 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: &50 + sha_pinning_required: &55 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -8667,9 +9029,9 @@ paths: schema: type: object properties: - enabled_organizations: *48 - allowed_actions: *49 - sha_pinning_required: *50 + enabled_organizations: *53 + allowed_actions: *54 + sha_pinning_required: *55 required: - enabled_organizations examples: @@ -8700,7 +9062,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &235 + schema: &255 type: object properties: days: @@ -8718,7 +9080,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &724 + '401': &743 description: Authorization failure '404': *6 x-github: @@ -8746,7 +9108,7 @@ paths: required: true content: application/json: - schema: &236 + schema: &256 type: object properties: days: @@ -8781,7 +9143,7 @@ paths: description: Response content: application/json: - schema: &51 + schema: &56 type: object properties: approval_policy: @@ -8795,7 +9157,7 @@ paths: required: - approval_policy examples: - default: &237 + default: &257 value: approval_policy: first_time_contributors '404': *6 @@ -8824,7 +9186,7 @@ paths: required: true content: application/json: - schema: *51 + schema: *56 examples: default: summary: Set approval policy to first time contributors @@ -8853,7 +9215,7 @@ paths: description: Response content: application/json: - schema: &238 + schema: &258 type: object required: - run_workflows_from_fork_pull_requests @@ -8879,7 +9241,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &52 + default: &57 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -8907,7 +9269,7 @@ paths: required: true content: application/json: - schema: &239 + schema: &259 type: object required: - run_workflows_from_fork_pull_requests @@ -8930,7 +9292,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *52 + default: *57 responses: '204': description: Empty response for successful settings update @@ -8970,7 +9332,7 @@ paths: type: number organizations: type: array - items: &62 + items: &67 title: Organization Simple description: A GitHub organization. type: object @@ -9045,7 +9407,7 @@ paths: - total_count - organizations examples: - default: &63 + default: &68 value: total_count: 1 organizations: @@ -9124,7 +9486,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *39 - - &53 + - &58 name: org_id description: The unique identifier of the organization. in: path @@ -9153,7 +9515,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *39 - - *53 + - *58 responses: '204': description: Response @@ -9182,7 +9544,7 @@ paths: description: Response content: application/json: - schema: &54 + schema: &59 type: object properties: github_owned_allowed: @@ -9203,7 +9565,7 @@ paths: items: type: string examples: - default: &55 + default: &60 value: github_owned_allowed: true verified_allowed: false @@ -9236,9 +9598,9 @@ paths: required: true content: application/json: - schema: *54 + schema: *59 examples: - selected_actions: *55 + selected_actions: *60 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9343,17 +9705,17 @@ paths: description: Success response content: application/json: - schema: &242 + schema: &262 type: object properties: - default_workflow_permissions: &56 + default_workflow_permissions: &61 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &57 + can_approve_pull_request_reviews: &62 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -9361,7 +9723,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &58 + default: &63 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -9391,13 +9753,13 @@ paths: required: true content: application/json: - schema: &243 + schema: &263 type: object properties: - default_workflow_permissions: *56 - can_approve_pull_request_reviews: *57 + default_workflow_permissions: *61 + can_approve_pull_request_reviews: *62 examples: - default: *58 + default: *63 responses: '204': description: Success response @@ -9442,7 +9804,7 @@ paths: type: number runner_groups: type: array - items: &59 + items: &64 type: object properties: id: @@ -9623,9 +9985,9 @@ paths: description: Response content: application/json: - schema: *59 + schema: *64 examples: - default: &60 + default: &65 value: id: 2 name: octo-runner-group @@ -9660,7 +10022,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: - *39 - - &61 + - &66 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -9672,9 +10034,9 @@ paths: description: Response content: application/json: - schema: *59 + schema: *64 examples: - default: *60 + default: *65 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9694,7 +10056,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: - *39 - - *61 + - *66 requestBody: required: false content: @@ -9748,7 +10110,7 @@ paths: description: Response content: application/json: - schema: *59 + schema: *64 examples: default: value: @@ -9784,7 +10146,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: - *39 - - *61 + - *66 responses: '204': description: Response @@ -9808,7 +10170,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: - *39 - - *61 + - *66 - *17 - *19 responses: @@ -9823,12 +10185,12 @@ paths: type: number organizations: type: array - items: *62 + items: *67 required: - total_count - organizations examples: - default: *63 + default: *68 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9848,7 +10210,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: - *39 - - *61 + - *66 requestBody: required: true content: @@ -9894,8 +10256,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: - *39 - - *61 - - *53 + - *66 + - *58 responses: '204': description: Response @@ -9918,8 +10280,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: - *39 - - *61 - - *53 + - *66 + - *58 responses: '204': description: Response @@ -9943,7 +10305,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: - *39 - - *61 + - *66 - *17 - *19 responses: @@ -9958,7 +10320,7 @@ paths: type: number runners: type: array - items: &65 + items: &70 title: Self hosted runners description: A self hosted runner type: object @@ -9992,7 +10354,7 @@ paths: type: boolean labels: type: array - items: &69 + items: &74 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -10025,7 +10387,7 @@ paths: - total_count - runners examples: - default: &66 + default: &71 value: total_count: 2 runners: @@ -10085,7 +10447,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: - *39 - - *61 + - *66 requestBody: required: true content: @@ -10130,8 +10492,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: - *39 - - *61 - - &64 + - *66 + - &69 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -10160,8 +10522,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: - *39 - - *61 - - *64 + - *66 + - *69 responses: '204': description: Response @@ -10204,9 +10566,9 @@ paths: type: number runners: type: array - items: *65 + items: *70 examples: - default: *66 + default: *71 headers: Link: *41 x-github: @@ -10236,7 +10598,7 @@ paths: application/json: schema: type: array - items: &247 + items: &267 title: Runner Application description: Runner Application type: object @@ -10261,7 +10623,7 @@ paths: - download_url - filename examples: - default: &248 + default: &268 value: - os: osx architecture: x64 @@ -10345,7 +10707,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &249 + '201': &269 description: Response content: application/json: @@ -10355,7 +10717,7 @@ paths: - runner - encoded_jit_config properties: - runner: *65 + runner: *70 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -10384,7 +10746,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': &107 + '409': &112 description: Conflict content: application/json: @@ -10422,7 +10784,7 @@ paths: description: Response content: application/json: - schema: &68 + schema: &73 title: Authentication Token description: Authentication Token type: object @@ -10446,7 +10808,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *67 + items: *72 single_file: type: - string @@ -10464,7 +10826,7 @@ paths: - token - expires_at examples: - default: &250 + default: &270 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10502,9 +10864,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *73 examples: - default: &251 + default: &271 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10528,15 +10890,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - *39 - - *64 + - *69 responses: '200': description: Response content: application/json: - schema: *65 + schema: *70 examples: - default: &252 + default: &272 value: id: 23 name: MBP @@ -10576,7 +10938,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - *39 - - *64 + - *69 responses: '204': description: Response @@ -10601,9 +10963,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: - *39 - - *64 + - *69 responses: - '200': &70 + '200': &75 description: Response content: application/json: @@ -10617,7 +10979,7 @@ paths: type: integer labels: type: array - items: *69 + items: *74 examples: default: value: @@ -10655,7 +11017,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: - *39 - - *64 + - *69 requestBody: required: true content: @@ -10679,7 +11041,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -10702,7 +11064,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: - *39 - - *64 + - *69 requestBody: required: true content: @@ -10727,7 +11089,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -10750,9 +11112,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: - *39 - - *64 + - *69 responses: - '200': &253 + '200': &273 description: Response content: application/json: @@ -10766,7 +11128,7 @@ paths: type: integer labels: type: array - items: *69 + items: *74 examples: default: value: @@ -10807,8 +11169,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: - *39 - - *64 - - &254 + - *69 + - &274 name: name description: The name of a self-hosted runner's custom label. in: path @@ -10816,7 +11178,7 @@ paths: schema: type: string responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -10841,13 +11203,13 @@ paths: description: Response content: application/json: - schema: &75 + schema: &80 title: Announcement Banner description: Announcement at either the repository, organization, or enterprise level type: object properties: - announcement: &71 + announcement: &76 type: - string - 'null' @@ -10856,7 +11218,7 @@ paths: 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)." examples: - Very **important** announcement about _something_. - expires_at: &72 + expires_at: &77 type: - string - 'null' @@ -10868,7 +11230,7 @@ paths: it to an empty string.' examples: - '"2021-01-01T00:00:00.000-07:00"' - user_dismissible: &73 + user_dismissible: &78 type: - boolean - 'null' @@ -10881,7 +11243,7 @@ paths: - expires_at - user_dismissible examples: - default: &74 + default: &79 summary: Announcement banner value: announcement: Very **important** announcement about _something_. @@ -10905,18 +11267,18 @@ paths: required: true content: application/json: - schema: &261 + schema: &281 title: Enterprise Announcement description: Enterprise global announcement type: object properties: - announcement: *71 - expires_at: *72 - user_dismissible: *73 + announcement: *76 + expires_at: *77 + user_dismissible: *78 required: - announcement examples: - default: *74 + default: *79 parameters: - *39 responses: @@ -10924,9 +11286,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *80 examples: - default: *74 + default: *79 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -11025,7 +11387,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - *39 - - &76 + - &81 name: org description: The organization name. The name is not case sensitive. in: path @@ -11042,7 +11404,7 @@ paths: application/json: schema: type: array - items: &78 + items: &83 title: Accessible Repository description: A repository that may be made accessible to a GitHub App. @@ -11096,7 +11458,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: - *39 - - *76 + - *81 - *17 - *19 responses: @@ -11195,7 +11557,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: - *39 - - *76 + - *81 responses: '200': description: A GitHub App installation that was installed previously. @@ -11203,14 +11565,14 @@ paths: application/json: schema: *20 examples: - default: *77 + default: *82 '201': description: A GitHub App installation. content: application/json: schema: *20 examples: - default: *77 + default: *82 requestBody: required: true content: @@ -11278,7 +11640,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: - *39 - - *76 + - *81 - *21 responses: '204': @@ -11306,7 +11668,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: - *39 - - *76 + - *81 - *21 - *17 - *19 @@ -11318,7 +11680,7 @@ paths: application/json: schema: type: array - items: *78 + items: *83 examples: default: value: @@ -11347,7 +11709,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: - *39 - - *76 + - *81 - *21 requestBody: required: true @@ -11387,7 +11749,7 @@ paths: application/json: schema: *20 examples: - default: *77 + default: *82 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -11408,7 +11770,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - *39 - - *76 + - *81 - *21 responses: '200': @@ -11418,7 +11780,7 @@ paths: application/json: schema: type: array - items: *78 + items: *83 examples: default: value: @@ -11469,7 +11831,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - *39 - - *76 + - *81 - *21 responses: '200': @@ -11479,7 +11841,7 @@ paths: application/json: schema: type: array - items: *78 + items: *83 examples: default: value: @@ -11556,7 +11918,7 @@ paths: required: false schema: type: string - - &262 + - &282 name: include description: |- The event types to include: @@ -11574,7 +11936,7 @@ paths: - web - git - all - - &263 + - &283 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. @@ -11582,7 +11944,7 @@ paths: required: false schema: type: string - - &264 + - &284 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. @@ -11590,7 +11952,7 @@ paths: required: false schema: type: string - - &265 + - &285 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11612,7 +11974,7 @@ paths: application/json: schema: type: array - items: &266 + items: &286 type: object properties: "@timestamp": @@ -11734,7 +12096,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &267 + default: &287 value: - "@timestamp": 1606929874512 action: team.add_member @@ -11914,7 +12276,7 @@ paths: vendor_specific: type: object oneOf: - - &82 + - &87 title: AzureBlobConfig description: Azure Blob Config for audit log streaming configuration. type: object @@ -11933,7 +12295,7 @@ paths: - key_id - encrypted_sas_url - container - - &83 + - &88 title: AzureHubConfig description: Azure Event Hubs Config for audit log streaming configuration. type: object @@ -11952,7 +12314,7 @@ paths: - name - encrypted_connstring - key_id - - &84 + - &89 title: AmazonS3OIDCConfig description: Amazon S3 OIDC Config for audit log streaming configuration. type: object @@ -11980,7 +12342,7 @@ paths: - bucket - key_id - region - - &85 + - &90 title: AmazonS3AccessKeysConfig description: Amazon S3 Access Keys Config for audit log streaming configuration. @@ -12014,7 +12376,7 @@ paths: - encrypted_secret_key - key_id - region - - &86 + - &91 title: SplunkConfig description: Splunk Config for Audit Log Stream Configuration type: object @@ -12042,7 +12404,7 @@ paths: - key_id - port - ssl_verify - - &87 + - &92 title: HecConfig description: Hec Config for Audit Log Stream Configuration type: object @@ -12074,7 +12436,7 @@ paths: - key_id - port - ssl_verify - - &88 + - &93 title: GoogleCloudConfig description: Google Cloud Config for audit log streaming configuration. type: object @@ -12092,7 +12454,7 @@ paths: - bucket - key_id - encrypted_json_credentials - - &89 + - &94 title: DatadogConfig description: Datadog Config for audit log streaming configuration. type: object @@ -12123,7 +12485,7 @@ paths: - stream_type - vendor_specific examples: - default: &90 + default: &95 value: enabled: false stream_type: Azure Event Hubs @@ -12137,7 +12499,7 @@ paths: description: The audit log stream configuration was created successfully. content: application/json: - schema: &79 + schema: &84 title: Get an audit log streaming configuration description: Get an audit log streaming configuration for an enterprise. type: object @@ -12169,7 +12531,7 @@ paths: - created_at - updated_at examples: - default: &80 + default: &85 value: id: 1 stream_type: Splunk @@ -12198,7 +12560,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: - *39 - - &81 + - &86 name: stream_id description: The ID of the audit log stream configuration. in: path @@ -12210,9 +12572,9 @@ paths: description: Lists one audit log stream configuration via stream ID. content: application/json: - schema: *79 + schema: *84 examples: - default: *80 + default: *85 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -12232,7 +12594,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - *39 - - *81 + - *86 requestBody: required: true content: @@ -12258,28 +12620,28 @@ paths: vendor_specific: type: object oneOf: - - *82 - - *83 - - *84 - - *85 - - *86 - *87 - *88 - *89 + - *90 + - *91 + - *92 + - *93 + - *94 required: - enabled - stream_type - vendor_specific examples: - default: *90 + default: *95 responses: '200': description: Successful update content: application/json: - schema: *79 + schema: *84 examples: - default: *80 + default: *85 '422': description: Validation error content: @@ -12310,7 +12672,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: - *39 - - *81 + - *86 responses: '204': description: The audit log stream configuration was deleted successfully. @@ -12337,13 +12699,13 @@ paths: subcategory: bypass-requests parameters: - *39 - - &91 + - &96 name: organization_name description: The name of the organization to filter on. in: query schema: type: string - - &92 + - &97 name: reviewer description: Filter bypass requests by the handle of the GitHub user who reviewed the bypass request. @@ -12351,7 +12713,7 @@ paths: required: false schema: type: string - - &93 + - &98 name: requester description: Filter bypass requests by the handle of the GitHub user who requested the bypass. @@ -12359,7 +12721,7 @@ paths: required: false schema: type: string - - &94 + - &99 name: time_period description: |- The time period to filter by. @@ -12375,7 +12737,7 @@ paths: - week - month default: day - - &95 + - &100 name: request_status description: The status of the bypass request to filter on. When specified, only requests with this status will be returned. @@ -12402,7 +12764,7 @@ paths: application/json: schema: type: array - items: &268 + items: &288 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12528,7 +12890,7 @@ paths: - array - 'null' description: The responses to the bypass request. - items: &96 + items: &101 title: Bypass response description: A response made by a delegated bypasser to a bypass request. @@ -12574,7 +12936,7 @@ paths: examples: - https://github.com/octo-org/smile/exemptions/1 examples: - default: &269 + default: &289 value: - id: 21 number: 42 @@ -12665,11 +13027,11 @@ paths: subcategory: delegated-bypass parameters: - *39 - - *91 - - *92 - - *93 - - *94 - - *95 + - *96 + - *97 + - *98 + - *99 + - *100 - *17 - *19 responses: @@ -12679,7 +13041,7 @@ paths: application/json: schema: type: array - items: &271 + items: &291 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -12797,7 +13159,7 @@ paths: - array - 'null' description: The responses to the bypass request. - items: *96 + items: *101 url: type: string format: uri @@ -12810,7 +13172,7 @@ paths: examples: - https://github.com/octo-org/smile/exemptions/1 examples: - default: &272 + default: &292 value: - id: 21 number: 42 @@ -12895,17 +13257,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *39 - - &277 + - &297 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: &100 + schema: &105 type: string description: The name of the tool used to generate the code scanning analysis. - - &278 + - &298 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 @@ -12913,23 +13275,23 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &101 + schema: &106 type: - string - 'null' description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *97 - - *98 + - *102 + - *103 - *19 - *17 - - *99 + - *104 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &279 + schema: &299 type: string description: State of a code scanning alert. enum: @@ -12954,42 +13316,42 @@ paths: application/json: schema: type: array - items: &280 + items: &300 type: object properties: - number: &109 + number: &119 type: integer description: The security alert number. readOnly: true - created_at: &116 + created_at: &126 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: &117 + updated_at: &127 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: &114 + url: &124 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &115 + html_url: &125 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &509 + instances_url: &526 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &102 + state: &107 type: - string - 'null' @@ -12999,7 +13361,7 @@ paths: - dismissed - fixed - - fixed_at: &119 + fixed_at: &129 type: - string - 'null' @@ -13011,7 +13373,7 @@ paths: anyOf: - type: 'null' - *4 - dismissed_at: &118 + dismissed_at: &128 type: - string - 'null' @@ -13019,7 +13381,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &510 + dismissed_reason: &527 type: - string - 'null' @@ -13030,14 +13392,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &511 + dismissed_comment: &528 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &512 + rule: &529 type: object properties: id: @@ -13098,26 +13460,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &513 + tool: &530 type: object properties: - name: *100 + name: *105 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *101 - most_recent_instance: &514 + guid: *106 + most_recent_instance: &531 type: object properties: - ref: &507 + ref: &524 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &524 + analysis_key: &541 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13128,13 +13490,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &525 + category: &542 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: *102 + state: *107 commit_sha: type: string message: @@ -13175,7 +13537,7 @@ paths: - test - library - - repository: &108 + repository: &113 title: Simple Repository description: A GitHub repository. type: object @@ -13519,7 +13881,7 @@ paths: - most_recent_instance - repository examples: - default: &281 + default: &301 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -13750,7 +14112,7 @@ paths: headers: Link: *41 '404': *6 - '503': &163 + '503': &179 description: Service unavailable content: application/json: @@ -13794,8 +14156,8 @@ paths: schema: type: integer default: 30 - - *97 - - *98 + - *102 + - *103 responses: '200': description: Response @@ -13803,7 +14165,7 @@ paths: application/json: schema: type: array - items: &103 + items: &108 type: object description: A code security configuration properties: @@ -14178,7 +14540,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &282 + code_scanning_options: &302 type: - object - 'null' @@ -14197,7 +14559,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &106 + code_scanning_default_setup_options: &111 type: - object - 'null' @@ -14316,9 +14678,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *103 + schema: *108 examples: - default: &104 + default: &109 value: id: 1325 target_type: enterprise @@ -14376,7 +14738,7 @@ paths: description: Response content: application/json: - schema: &284 + schema: &304 type: array description: A list of default code security configurations items: @@ -14390,9 +14752,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *103 + configuration: *108 examples: - default: &285 + default: &305 value: - default_for_new_repos: public configuration: @@ -14481,7 +14843,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - *39 - - &105 + - &110 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -14493,9 +14855,9 @@ paths: description: Response content: application/json: - schema: *103 + schema: *108 examples: - default: *104 + default: *109 '304': *35 '403': *27 '404': *6 @@ -14520,7 +14882,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - *39 - - *105 + - *110 requestBody: required: true content: @@ -14599,7 +14961,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *106 + code_scanning_default_setup_options: *111 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -14687,13 +15049,13 @@ paths: description: Response content: application/json: - schema: *103 + schema: *108 examples: - default: *104 + default: *109 '304': *35 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14717,14 +15079,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - *39 - - *105 + - *110 responses: - '204': &129 + '204': &139 description: A header with no content is returned. '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14749,7 +15111,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - *39 - - *105 + - *110 requestBody: required: true content: @@ -14776,7 +15138,7 @@ paths: '202': *37 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14801,7 +15163,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: - *39 - - *105 + - *110 requestBody: required: true content: @@ -14841,12 +15203,12 @@ paths: - none - private_and_internal - public - configuration: *103 + configuration: *108 examples: default: value: default_for_new_repos: all - configuration: &283 + configuration: &303 value: id: 1325 target_type: organization @@ -14903,7 +15265,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - *39 - - *105 + - *110 - 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)." @@ -14912,8 +15274,8 @@ paths: schema: type: integer default: 30 - - *97 - - *98 + - *102 + - *103 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -14931,7 +15293,7 @@ paths: application/json: schema: type: array - items: &286 + items: &306 type: object description: Repositories associated with a code security configuration and attachment status @@ -14949,13 +15311,13 @@ paths: - failed - updating - removed_by_enterprise - repository: *108 + repository: *113 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: &287 + repository: &307 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -15438,7 +15800,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &120 + items: &130 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -15451,12 +15813,12 @@ paths: organization: anyOf: - type: 'null' - - *62 + - *67 assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &273 + - &293 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15533,7 +15895,7 @@ paths: parent: anyOf: - type: 'null' - - &344 + - &362 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -15651,7 +16013,7 @@ paths: - slug - parent - type - - &174 + - &190 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -15774,7 +16136,7 @@ paths: - created_at additionalProperties: false examples: - default: &121 + default: &131 value: total_seats: 2 seats: @@ -16226,7 +16588,7 @@ paths: application/json: schema: type: array - items: &171 + items: &187 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -16541,7 +16903,7 @@ paths: - date additionalProperties: true examples: - default: &172 + default: &188 value: - date: '2024-06-24' total_active_users: 24 @@ -16643,7 +17005,7 @@ paths: '500': *38 '403': *27 '404': *6 - '422': &173 + '422': &189 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -16654,6 +17016,213 @@ 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: + - *39 + - &114 + name: day + description: The day to request data for, in `YYYY-MM-DD` format. + in: query + required: true + schema: + type: string + format: date + examples: + - '2025-10-13' + responses: + '200': + description: Response + content: + application/json: + schema: &115 + 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: &116 + 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': *38 + '403': *27 + '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: + - *39 + responses: + '200': + description: Response + content: + application/json: + schema: &117 + 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: &118 + 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': *38 + '403': *27 + '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: + - *39 + - *114 + responses: + '200': + description: Response + content: + application/json: + schema: *115 + examples: + default: *116 + '500': *38 + '403': *27 + '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: + - *39 + responses: + '200': + description: Response + content: + application/json: + schema: *117 + examples: + default: *118 + '500': *38 + '403': *27 + '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 @@ -16673,7 +17242,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *39 - - &294 + - &314 name: state in: query description: |- @@ -16682,7 +17251,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &295 + - &315 name: severity in: query description: |- @@ -16691,7 +17260,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &296 + - &316 name: ecosystem in: query description: |- @@ -16700,14 +17269,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &297 + - &317 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 - - &298 + - &318 name: epss_percentage in: query description: |- @@ -16719,7 +17288,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 - - &560 + - &577 name: has in: query description: |- @@ -16733,7 +17302,7 @@ paths: type: string enum: - patch - - &299 + - &319 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -16743,7 +17312,7 @@ paths: enum: - development - runtime - - &300 + - &320 name: sort in: query description: |- @@ -16758,34 +17327,9 @@ paths: - updated - epss_percentage default: created - - *99 - - *97 - - *98 - - &301 - 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 - - &302 - 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 + - *104 + - *102 + - *103 - *17 responses: '200': @@ -16794,11 +17338,11 @@ paths: application/json: schema: type: array - items: &303 + items: &321 type: object description: A Dependabot alert. properties: - number: *109 + number: *119 state: type: string description: The state of the Dependabot alert. @@ -16813,7 +17357,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &110 + package: &120 type: object description: Details for the vulnerable package. readOnly: true @@ -16861,7 +17405,7 @@ paths: - direct - transitive - - security_advisory: &561 + security_advisory: &578 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -16892,13 +17436,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &113 + items: &123 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *110 + package: *120 severity: type: string description: The severity of the vulnerability. @@ -16966,8 +17510,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *111 - epss: *112 + cvss_severities: *121 + epss: *122 cwes: type: array description: Details for the advisory pertaining to Common @@ -17067,12 +17611,12 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *113 - url: *114 - html_url: *115 - created_at: *116 - updated_at: *117 - dismissed_at: *118 + security_vulnerability: *123 + url: *124 + html_url: *125 + created_at: *126 + updated_at: *127 + dismissed_at: *128 dismissed_by: anyOf: - type: 'null' @@ -17096,8 +17640,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *119 - auto_dismissed_at: &562 + fixed_at: *129 + auto_dismissed_at: &579 type: - string - 'null' @@ -17105,7 +17649,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - repository: *108 + repository: *113 required: - number - state @@ -17124,7 +17668,7 @@ paths: - repository additionalProperties: false examples: - default: &304 + default: &322 value: - number: 2 state: dismissed @@ -17541,7 +18085,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: - *39 - - &178 + - &194 name: username description: The handle for the GitHub user account. in: path @@ -17563,9 +18107,9 @@ paths: teams or multiple organizations are only counted once. seats: type: array - items: *120 + items: *130 examples: - default: *121 + default: *131 '500': *38 '401': *23 '403': *27 @@ -17608,7 +18152,7 @@ paths: type: integer network_configurations: type: array - items: &122 + items: &132 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -17653,7 +18197,7 @@ paths: - name - created_on examples: - default: &407 + default: &424 value: total_count: 2 network_configurations: @@ -17731,9 +18275,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: &123 + default: &133 value: id: 123456789ABCDEF name: My network configuration @@ -17760,7 +18304,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: - *39 - - &124 + - &134 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -17772,9 +18316,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: *123 + default: *133 headers: Link: *41 x-github: @@ -17794,7 +18338,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: - *39 - - *124 + - *134 requestBody: required: true content: @@ -17833,9 +18377,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: *123 + default: *133 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -17853,7 +18397,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: - *39 - - *124 + - *134 responses: '204': description: Response @@ -17876,7 +18420,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: - *39 - - &408 + - &425 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -17888,7 +18432,7 @@ paths: description: Response content: application/json: - schema: &409 + schema: &426 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -17927,7 +18471,7 @@ paths: - subnet_id - region examples: - default: &410 + default: &427 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -17941,6 +18485,540 @@ 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: + - *39 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &135 + 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 + examples: + - organization + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - enterprise_actors + - enterprise_and_org_actors + - + description: Who can edit the values of the property + examples: + - enterprise_actors + required: + - property_name + - value_type + examples: + default: &136 + 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': *27 + '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: + - *39 + 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: *135 + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: *136 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *135 + examples: + default: *136 + '403': *27 + '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: + - *39 + - &137 + name: custom_property_name + description: The custom property name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: *135 + examples: + default: &138 + 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': *27 + '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: + - *39 + - *137 + 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 + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property. + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property. + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property. + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - enterprise_actors + - enterprise_and_org_actors + - + description: Who can edit the values of the property. + examples: + - enterprise_actors + 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: *135 + examples: + default: *138 + '403': *27 + '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: + - *39 + - *137 + responses: + '204': *139 + '403': *27 + '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: + - *39 + - *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 + examples: + - 1296269 + organization_login: + type: string + examples: + - Hello-World + properties: + type: array + items: &140 + 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 + type: + - 'null' + - string + - array + 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: *41 + '403': *27 + '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: + - *39 + 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: *140 + 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': *27 + '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 @@ -17962,7 +19040,7 @@ paths: application/json: schema: type: array - items: &125 + items: &141 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -18038,7 +19116,7 @@ paths: - property_name - value_type examples: - default: &126 + default: &142 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -18095,7 +19173,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *125 + items: *141 minItems: 1 maxItems: 100 required: @@ -18125,9 +19203,9 @@ paths: application/json: schema: type: array - items: *125 + items: *141 examples: - default: *126 + default: *142 '403': *27 '404': *6 x-github: @@ -18150,22 +19228,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - *39 - - *76 - - &127 - name: custom_property_name - description: The custom property name - in: path - required: true - schema: - type: string + - *81 + - *137 responses: '200': description: Response content: application/json: - schema: *125 + schema: *141 examples: - default: &128 + default: &143 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -18198,15 +19270,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - *39 - - *127 + - *137 responses: '200': description: Response content: application/json: - schema: *125 + schema: *141 examples: - default: *128 + default: *143 '403': *27 '404': *6 x-github: @@ -18228,12 +19300,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: - *39 - - *127 + - *137 requestBody: required: true content: application/json: - schema: &375 + schema: &393 title: Custom Property Set Payload description: Custom property set payload type: object @@ -18306,9 +19378,9 @@ paths: description: Response content: application/json: - schema: *125 + schema: *141 examples: - default: *128 + default: *143 '403': *27 '404': *6 x-github: @@ -18330,9 +19402,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - *39 - - *127 + - *137 responses: - '204': *129 + '204': *139 '403': *27 '404': *6 x-github: @@ -18372,7 +19444,7 @@ paths: - push - repository default: branch - enforcement: &136 + enforcement: &152 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights @@ -18385,7 +19457,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &137 + items: &153 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -18427,7 +19499,7 @@ paths: - pull_request - exempt default: always - conditions: &160 + conditions: &176 title: Enterprise ruleset conditions type: object description: Conditions for an enterprise ruleset. The conditions @@ -18441,7 +19513,7 @@ paths: description: Conditions to target organizations by name and all repositories allOf: - - &130 + - &144 title: Repository ruleset conditions for organization names type: object description: Parameters for an organization name condition @@ -18467,7 +19539,7 @@ paths: type: string required: - organization_name - - &133 + - &147 title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -18496,7 +19568,7 @@ paths: is prevented. required: - repository_name - - &132 + - &146 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name condition @@ -18524,8 +19596,8 @@ paths: description: Conditions to target organizations by name and repositories by property allOf: - - *130 - - &135 + - *144 + - &149 title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -18538,7 +19610,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &131 + items: &145 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a repository @@ -18569,16 +19641,16 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *131 + items: *145 required: - repository_property - - *132 + - *146 - type: object title: organization_id_and_repository_name description: Conditions to target organizations by id and all repositories allOf: - - &134 + - &148 title: Repository ruleset conditions for organization IDs type: object description: Parameters for an organization ID condition @@ -18595,25 +19667,80 @@ paths: type: integer required: - organization_id - - *133 - - *132 + - *147 + - *146 - type: object title: organization_id_and_repository_property description: Conditions to target organization by id and repositories by property allOf: - - *134 - - *135 - - *132 + - *148 + - *149 + - *146 + - type: object + title: organization_property_and_repository_name + description: Conditions to target organizations by property and + all repositories + allOf: + - &151 + 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: &150 + 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: *150 + required: + - organization_property + - *147 + - *146 + - type: object + title: organization_property_and_repository_property + description: Conditions to target organizations by property and + repositories by property + allOf: + - *151 + - *149 + - *146 rules: type: array description: An array of rules within the ruleset. - items: &161 + items: &177 title: Repository Rule type: object description: A repository rule. oneOf: - - &138 + - &154 title: creation description: Only allow users with bypass permission to create matching refs. @@ -18625,7 +19752,7 @@ paths: type: string enum: - creation - - &139 + - &155 title: update description: Only allow users with bypass permission to update matching refs. @@ -18646,7 +19773,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &140 + - &156 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -18658,7 +19785,7 @@ paths: type: string enum: - deletion - - &141 + - &157 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -18670,7 +19797,7 @@ paths: type: string enum: - required_linear_history - - &142 + - &158 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches @@ -18694,7 +19821,7 @@ paths: type: string required: - required_deployment_environments - - &143 + - &159 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -18706,7 +19833,7 @@ paths: type: string enum: - required_signatures - - &144 + - &160 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. @@ -18766,7 +19893,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &145 + - &161 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed @@ -18813,7 +19940,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &146 + - &162 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -18825,7 +19952,7 @@ paths: type: string enum: - non_fast_forward - - &147 + - &163 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -18861,7 +19988,7 @@ paths: required: - operator - pattern - - &148 + - &164 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -18897,7 +20024,7 @@ paths: required: - operator - pattern - - &149 + - &165 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -18933,7 +20060,7 @@ paths: required: - operator - pattern - - &150 + - &166 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -18969,7 +20096,7 @@ paths: required: - operator - pattern - - &151 + - &167 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -19005,7 +20132,7 @@ paths: required: - operator - pattern - - &152 + - &168 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. @@ -19029,7 +20156,7 @@ paths: type: string required: - restricted_file_paths - - &153 + - &169 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit @@ -19053,7 +20180,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &154 + - &170 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -19076,7 +20203,7 @@ paths: type: string required: - restricted_file_extensions - - &155 + - &171 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. @@ -19100,7 +20227,7 @@ paths: maximum: 100 required: - max_file_size - - &156 + - &172 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -19149,7 +20276,7 @@ paths: - repository_id required: - workflows - - &157 + - &173 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning @@ -19235,7 +20362,7 @@ paths: description: Response content: application/json: - schema: &158 + schema: &174 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -19270,11 +20397,11 @@ paths: source: type: string description: The name of the source - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 + items: *153 current_user_can_bypass: type: string description: |- @@ -19306,8 +20433,8 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - *132 - - &380 + - *146 + - &397 title: Organization ruleset conditions type: object description: |- @@ -19321,14 +20448,14 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *132 - - *133 + - *146 + - *147 - type: object title: repository_id_and_ref_name description: Conditions to target repositories by id and refs by name allOf: - - *132 + - *146 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -19350,23 +20477,23 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *132 - - *135 + - *146 + - *149 type: - 'null' - object rules: type: array - items: &679 + items: &698 title: Repository Rule type: object description: A repository rule. oneOf: - - *138 - - *139 - - *140 - - *141 - - &676 + - *154 + - *155 + - *156 + - *157 + - &695 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -19444,23 +20571,23 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - *142 - - *143 - - *144 - - *145 - - *146 - - *147 - - *148 - - *149 - - *150 - - *151 - - *152 - - *153 - - *154 - - *155 - - *156 - - *157 - - &677 + - *158 + - *159 + - *160 + - *161 + - *162 + - *163 + - *164 + - *165 + - *166 + - *167 + - *168 + - *169 + - *170 + - *171 + - *172 + - *173 + - &696 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -19490,7 +20617,7 @@ paths: type: string format: date-time examples: - default: &159 + default: &175 value: id: 21 name: super cool ruleset @@ -19549,9 +20676,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *159 + default: *175 '404': *6 '500': *38 x-github: @@ -19595,16 +20722,16 @@ paths: - tag - push - repository - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 - conditions: *160 + items: *153 + conditions: *176 rules: description: An array of rules within the ruleset. type: array - items: *161 + items: *177 examples: default: value: @@ -19628,9 +20755,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *159 + default: *175 '404': *6 '500': *38 x-github: @@ -19692,7 +20819,7 @@ paths: application/json: schema: type: array - items: &162 + items: &178 title: Ruleset version type: object description: The historical version of a ruleset @@ -19716,7 +20843,7 @@ paths: type: string format: date-time examples: - default: &383 + default: &400 value: - version_id: 3 actor: @@ -19769,9 +20896,9 @@ paths: description: Response content: application/json: - schema: &384 + schema: &401 allOf: - - *162 + - *178 - type: object required: - state @@ -19824,7 +20951,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *39 - - &385 + - &402 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -19835,7 +20962,7 @@ paths: enum: - open - resolved - - &386 + - &403 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -19845,7 +20972,7 @@ paths: required: false schema: type: string - - &387 + - &404 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -19854,7 +20981,7 @@ paths: required: false schema: type: string - - &388 + - &405 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. @@ -19866,11 +20993,11 @@ paths: - created - updated default: created - - *99 + - *104 - *17 - - *97 - - *98 - - &389 + - *102 + - *103 + - &406 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -19879,7 +21006,7 @@ paths: required: false schema: type: string - - &390 + - &407 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -19888,7 +21015,7 @@ paths: schema: type: boolean default: false - - &391 + - &408 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -19897,7 +21024,7 @@ paths: schema: type: boolean default: false - - &392 + - &409 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -19913,30 +21040,30 @@ paths: application/json: schema: type: array - items: &393 + items: &410 type: object properties: - number: *109 - created_at: *116 + number: *119 + created_at: *126 updated_at: anyOf: - type: 'null' - - *117 - url: *114 - html_url: *115 + - *127 + url: *124 + html_url: *125 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &691 + state: &710 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: &692 + resolution: &711 type: - string - 'null' @@ -19970,7 +21097,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *108 + repository: *113 push_protection_bypassed: type: - boolean @@ -20043,14 +21170,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &693 + - &712 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &695 + - &714 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -20107,7 +21234,7 @@ paths: - blob_url - commit_sha - commit_url - - &696 + - &715 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. @@ -20168,7 +21295,7 @@ paths: - page_url - commit_sha - commit_url - - &697 + - &716 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -20183,7 +21310,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &698 + - &717 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -20198,7 +21325,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &699 + - &718 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -20213,7 +21340,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &700 + - &719 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -20228,7 +21355,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &701 + - &720 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -20243,7 +21370,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &702 + - &721 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -20258,7 +21385,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &703 + - &722 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. @@ -20273,7 +21400,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &704 + - &723 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. @@ -20288,7 +21415,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &705 + - &724 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. @@ -20303,7 +21430,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &706 + - &725 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. @@ -20318,7 +21445,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &707 + - &726 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 @@ -20343,7 +21470,7 @@ paths: - type: 'null' - *4 examples: - default: &394 + default: &411 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -20521,9 +21648,9 @@ paths: headers: Link: *41 '404': *6 - '503': *163 + '503': *179 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning @@ -20552,13 +21679,13 @@ paths: description: Response content: application/json: - schema: &395 + schema: &412 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: &165 + pattern_config_version: &181 type: - string - 'null' @@ -20568,7 +21695,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &164 + items: &180 type: object properties: token_type: @@ -20637,9 +21764,9 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *164 + items: *180 examples: - default: &396 + default: &413 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -20694,7 +21821,7 @@ paths: schema: type: object properties: - pattern_config_version: *165 + pattern_config_version: *181 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -20720,7 +21847,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *165 + custom_pattern_version: *181 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -20756,7 +21883,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 "/enterprises/{enterprise}/settings/billing/actions": get: @@ -20783,7 +21910,7 @@ paths: description: Response content: application/json: - schema: &398 + schema: &415 type: object properties: total_minutes_used: @@ -20853,7 +21980,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &399 + default: &416 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -20884,7 +22011,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &400 + - &417 name: advanced_security_product in: query description: | @@ -20904,7 +22031,7 @@ paths: description: Success content: application/json: - schema: &401 + schema: &418 type: object properties: total_advanced_security_committers: @@ -20967,7 +22094,7 @@ paths: required: - repositories examples: - default: &402 + default: &419 value: total_advanced_security_committers: 2 total_count: 2 @@ -21006,6 +22133,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise parameters: - *39 + - 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 @@ -21078,7 +22215,7 @@ paths: '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21208,7 +22345,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - *39 - - &168 + - &184 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -21220,7 +22357,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &166 + schema: &182 type: object properties: id: @@ -21260,7 +22397,7 @@ paths: - name - resources examples: - default: &167 + default: &183 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -21274,7 +22411,7 @@ paths: '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21324,15 +22461,15 @@ paths: description: Response when updating a cost center content: application/json: - schema: *166 + schema: *182 examples: - default: *167 + default: *183 '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21350,7 +22487,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - *39 - - *168 + - *184 responses: '200': description: Response when deleting a cost center @@ -21389,7 +22526,7 @@ paths: '404': *6 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21410,7 +22547,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - *39 - - *168 + - *184 requestBody: required: true content: @@ -21481,9 +22618,9 @@ paths: previous_cost_center: yet-another-cost-center '400': *14 '403': *27 - '409': *107 + '409': *112 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21503,7 +22640,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - *39 - - *168 + - *184 requestBody: required: true content: @@ -21550,7 +22687,7 @@ paths: '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21581,7 +22718,7 @@ paths: description: Response content: application/json: - schema: &403 + schema: &420 type: object properties: total_gigabytes_bandwidth_used: @@ -21599,7 +22736,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &404 + default: &421 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -21612,8 +22749,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 @@ -21622,7 +22761,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *39 - - &169 + - &185 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, @@ -21631,7 +22770,7 @@ paths: required: false schema: type: integer - - &213 + - &231 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 @@ -21640,7 +22779,7 @@ paths: required: false schema: type: integer - - &170 + - &186 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 @@ -21656,21 +22795,21 @@ paths: required: false schema: type: string - - &214 + - &232 name: user description: The user name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &215 + - &233 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &216 + - &234 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -21754,19 +22893,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 @@ -21809,7 +22948,7 @@ paths: '403': *27 '404': *6 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21840,7 +22979,7 @@ paths: description: Response content: application/json: - schema: &405 + schema: &422 type: object properties: days_left_in_billing_cycle: @@ -21858,7 +22997,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &406 + default: &423 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -21883,8 +23022,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *39 - - *169 - - &217 + - *185 + - &235 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 @@ -21893,8 +23032,8 @@ paths: required: false schema: type: integer - - *170 - - &218 + - *186 + - &236 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 @@ -21915,7 +23054,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &219 + schema: &237 type: object properties: usageItems: @@ -21968,7 +23107,7 @@ paths: - netAmount - organizationName examples: - default: &220 + default: &238 value: usageItems: - date: '2023-08-01' @@ -21985,7 +23124,7 @@ paths: '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -22056,13 +23195,13 @@ paths: application/json: schema: type: array - items: *171 + items: *187 examples: - default: *172 + default: *188 '500': *38 '403': *27 '404': *6 - '422': *173 + '422': *189 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -22089,9 +23228,9 @@ paths: application/json: schema: type: array - items: *174 + items: *190 examples: - default: &175 + default: &191 value: - id: 1 name: Justice League @@ -22148,6 +23287,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: type: - string @@ -22167,9 +23318,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *190 examples: - default: *175 + default: *191 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22187,7 +23338,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *39 - - &176 + - &192 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -22206,7 +23357,7 @@ paths: type: array items: *4 examples: - default: &177 + default: &193 value: - login: octocat id: 1 @@ -22245,7 +23396,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *39 - - *176 + - *192 requestBody: required: true content: @@ -22276,7 +23427,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22294,7 +23445,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *39 - - *176 + - *192 requestBody: required: true content: @@ -22325,7 +23476,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22343,8 +23494,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *39 - - *176 - - *178 + - *192 + - *194 responses: '200': description: User is a member of the enterprise team. @@ -22352,7 +23503,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &179 + exampleKey1: &195 value: login: octocat id: 1 @@ -22388,8 +23539,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *39 - - *176 - - *178 + - *192 + - *194 responses: '201': description: Successfully added team member @@ -22397,7 +23548,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *179 + exampleKey1: *195 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22415,8 +23566,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *39 - - *176 - - *178 + - *192 + - *194 responses: '204': description: Response @@ -22426,6 +23577,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: + - *39 + - *192 + - *17 + - *19 + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: *67 + examples: + default: &196 + 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: + - *39 + - *192 + 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: *67 + examples: + default: &230 + 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: + - *39 + - *192 + 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: + - *39 + - *192 + - *81 + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: *67 + examples: + default: *196 + '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: + - *39 + - *192 + - *81 + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: *67 + examples: + default: *196 + 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: + - *39 + - *192 + - *81 + 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 @@ -22441,7 +23813,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *39 - - &180 + - &197 name: team_slug description: The slug of the team name. in: path @@ -22453,9 +23825,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *190 examples: - default: *175 + default: *191 headers: Link: *41 '403': *27 @@ -22475,7 +23847,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *39 - - *180 + - *197 requestBody: required: true content: @@ -22503,6 +23875,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: type: - string @@ -22521,9 +23905,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *190 examples: - default: *175 + default: *191 headers: Link: *41 '403': *27 @@ -22546,7 +23930,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *39 - - *180 + - *197 responses: '204': description: Response @@ -22645,7 +24029,7 @@ paths: application/json: schema: type: array - items: &208 + items: &225 title: Event description: Event type: object @@ -22656,7 +24040,7 @@ paths: type: - string - 'null' - actor: &181 + actor: &198 title: Actor description: Actor type: object @@ -22697,7 +24081,7 @@ paths: - id - name - url - org: *181 + org: *198 payload: oneOf: - title: CreateEvent @@ -22744,7 +24128,7 @@ paths: properties: action: type: string - discussion: &829 + discussion: &847 title: Discussion description: A Discussion in a repository. type: object @@ -23041,7 +24425,7 @@ paths: - id labels: type: array - items: &182 + items: &199 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -23124,7 +24508,7 @@ paths: properties: action: type: string - issue: &183 + issue: &200 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -23247,7 +24631,7 @@ paths: milestone: anyOf: - type: 'null' - - &368 + - &386 title: Milestone description: A collection of related issues and pull requests. @@ -23419,7 +24803,7 @@ paths: timeline_url: type: string format: uri - type: &331 + type: &349 title: Issue Type description: The type of issue. type: @@ -23473,12 +24857,12 @@ paths: - node_id - name - description - repository: *67 + repository: *72 performed_via_github_app: anyOf: - type: 'null' - *5 - author_association: &184 + author_association: &201 title: author_association type: string description: How the author is associated with the @@ -23494,7 +24878,7 @@ paths: - OWNER examples: - OWNER - reactions: &185 + reactions: &202 title: Reaction Rollup type: object properties: @@ -23530,7 +24914,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &751 + sub_issues_summary: &770 title: Sub-issues Summary type: object properties: @@ -23551,7 +24935,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &752 + issue_dependencies_summary: &771 title: Issue Dependencies Summary type: object properties: @@ -23570,7 +24954,7 @@ paths: - total_blocking issue_field_values: type: array - items: &753 + items: &772 title: Issue Field Value description: A value assigned to an issue field type: object @@ -23670,10 +25054,10 @@ paths: assignees: type: array items: *4 - label: *182 + label: *199 labels: type: array - items: *182 + items: *199 required: - action - issue @@ -23682,8 +25066,8 @@ paths: properties: action: type: string - issue: *183 - comment: &617 + issue: *200 + comment: &634 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -23733,12 +25117,12 @@ paths: issue_url: type: string format: uri - author_association: *184 + author_association: *201 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *185 + reactions: *202 required: - id - node_id @@ -23917,7 +25301,7 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 allow_forking: type: boolean is_template: @@ -24008,7 +25392,7 @@ paths: type: string number: type: integer - pull_request: &187 + pull_request: &204 title: Pull Request Minimal type: object properties: @@ -24079,10 +25463,10 @@ paths: assignees: type: array items: *4 - label: *182 + label: *199 labels: type: array - items: *182 + items: *199 required: - action - number @@ -24092,7 +25476,7 @@ paths: properties: action: type: string - pull_request: *187 + pull_request: *204 comment: type: object properties: @@ -24346,7 +25730,7 @@ paths: - pull_request updated_at: type: string - pull_request: *187 + pull_request: *204 required: - action - review @@ -24395,7 +25779,7 @@ paths: updated_at: type: string format: date-time - reactions: *185 + reactions: *202 required: - action - comment @@ -24406,7 +25790,7 @@ paths: type: string release: allOf: - - &669 + - &688 title: Release description: A release. type: object @@ -24488,7 +25872,7 @@ paths: author: *4 assets: type: array - items: &670 + items: &689 title: Release Asset description: Data related to a release. type: object @@ -24563,7 +25947,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *185 + reactions: *202 required: - assets_url - upload_url @@ -24656,7 +26040,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24746,7 +26130,7 @@ paths: _links: type: object properties: - timeline: &188 + timeline: &205 title: Link With Type description: Hypermedia Link with Type type: object @@ -24758,17 +26142,17 @@ paths: required: - href - type - user: *188 - security_advisories: *188 - current_user: *188 - current_user_public: *188 - current_user_actor: *188 - current_user_organization: *188 + user: *205 + security_advisories: *205 + current_user: *205 + current_user_public: *205 + current_user_actor: *205 + current_user_organization: *205 current_user_organizations: type: array - items: *188 - repository_discussions: *188 - repository_discussions_category: *188 + items: *205 + repository_discussions: *205 + repository_discussions_category: *205 required: - timeline - user @@ -24830,7 +26214,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *189 + - *206 - *17 - *19 responses: @@ -24840,7 +26224,7 @@ paths: application/json: schema: type: array - items: &190 + items: &207 title: Base Gist description: Base Gist type: object @@ -24937,7 +26321,7 @@ paths: - created_at - updated_at examples: - default: &191 + default: &208 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -25061,7 +26445,7 @@ paths: description: Response content: application/json: - schema: &192 + schema: &209 title: Gist Simple description: Gist Simple type: object @@ -25079,7 +26463,7 @@ paths: url: type: string format: uri - user: &765 + user: &784 title: Public User description: Public User type: object @@ -25453,7 +26837,7 @@ paths: truncated: type: boolean examples: - default: &193 + default: &210 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -25557,7 +26941,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *189 + - *206 - *17 - *19 responses: @@ -25567,9 +26951,9 @@ paths: application/json: schema: type: array - items: *190 + items: *207 examples: - default: *191 + default: *208 headers: Link: *41 '422': *15 @@ -25591,7 +26975,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *189 + - *206 - *17 - *19 responses: @@ -25601,9 +26985,9 @@ paths: application/json: schema: type: array - items: *190 + items: *207 examples: - default: *191 + default: *208 headers: Link: *41 '401': *23 @@ -25631,7 +27015,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &194 + - &211 name: gist_id description: The unique identifier of the gist. in: path @@ -25643,10 +27027,10 @@ paths: description: Response content: application/json: - schema: *192 + schema: *209 examples: - default: *193 - '403': &197 + default: *210 + '403': &214 description: Forbidden Gist content: application/json: @@ -25695,7 +27079,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *194 + - *211 requestBody: required: true content: @@ -25759,9 +27143,9 @@ paths: description: Response content: application/json: - schema: *192 + schema: *209 examples: - updateGist: *193 + updateGist: *210 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -25919,7 +27303,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *194 + - *211 responses: '204': description: Response @@ -25948,7 +27332,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *194 + - *211 - *17 - *19 responses: @@ -25958,7 +27342,7 @@ paths: application/json: schema: type: array - items: &195 + items: &212 title: Gist Comment description: A comment made to a gist. type: object @@ -25996,7 +27380,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *184 + author_association: *201 required: - url - id @@ -26061,7 +27445,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *194 + - *211 requestBody: required: true content: @@ -26087,9 +27471,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *212 examples: - default: &196 + default: &213 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -26147,8 +27531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *194 - - &198 + - *211 + - &215 name: comment_id description: The unique identifier of the comment. in: path @@ -26161,12 +27545,12 @@ paths: description: Response content: application/json: - schema: *195 + schema: *212 examples: - default: *196 + default: *213 '304': *35 '404': *6 - '403': *197 + '403': *214 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26188,8 +27572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *194 - - *198 + - *211 + - *215 requestBody: required: true content: @@ -26215,9 +27599,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *212 examples: - default: *196 + default: *213 '404': *6 x-github: githubCloudOnly: false @@ -26234,8 +27618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *194 - - *198 + - *211 + - *215 responses: '204': description: Response @@ -26258,7 +27642,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *194 + - *211 - *17 - *19 responses: @@ -26359,7 +27743,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *194 + - *211 - *17 - *19 responses: @@ -26369,7 +27753,7 @@ paths: application/json: schema: type: array - items: *192 + items: *209 examples: default: value: @@ -26434,13 +27818,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *194 + - *211 responses: '201': description: Response content: application/json: - schema: *190 + schema: *207 examples: default: value: @@ -26511,7 +27895,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *194 + - *211 responses: '204': description: Response if gist is starred @@ -26541,7 +27925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *194 + - *211 responses: '204': description: Response @@ -26563,7 +27947,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *194 + - *211 responses: '204': description: Response @@ -26592,7 +27976,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *194 + - *211 - name: sha in: path required: true @@ -26603,9 +27987,9 @@ paths: description: Response content: application/json: - schema: *192 + schema: *209 examples: - default: *193 + default: *210 '422': *15 '404': *6 '403': *27 @@ -26766,7 +28150,7 @@ paths: type: integer repositories: type: array - items: *67 + items: *72 repository_selection: type: string examples: @@ -26974,7 +28358,7 @@ paths: - closed - all default: open - - &334 + - &352 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -26992,8 +28376,8 @@ paths: - updated - comments default: created - - *99 - - *189 + - *104 + - *206 - name: collab in: query required: false @@ -27023,9 +28407,9 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: &335 + default: &353 value: - id: 1 node_id: MDU6SXNzdWUx @@ -27305,7 +28689,7 @@ paths: application/json: schema: type: array - items: *186 + items: *203 examples: default: value: @@ -27603,7 +28987,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &199 + X-CommonMarker-Version: &216 example: 0.17.4 schema: type: string @@ -27658,7 +29042,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *199 + X-CommonMarker-Version: *216 content: text/html: schema: @@ -27687,7 +29071,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: - - &202 + - &219 name: account_id description: account_id parameter in: path @@ -27699,7 +29083,7 @@ paths: description: Response content: application/json: - schema: &201 + schema: &218 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -27733,7 +29117,7 @@ paths: - 'null' id: type: integer - plan: &200 + plan: &217 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -27836,7 +29220,7 @@ paths: - 'null' updated_at: type: string - plan: *200 + plan: *217 required: - url - id @@ -27844,7 +29228,7 @@ paths: - login - marketplace_purchase examples: - default: &203 + default: &220 value: url: https://api.github.com/orgs/github type: Organization @@ -27929,9 +29313,9 @@ paths: application/json: schema: type: array - items: *200 + items: *217 examples: - default: &204 + default: &221 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -27971,14 +29355,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &205 + - &222 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &206 + - &223 name: sort description: The property to sort the results by. in: query @@ -28008,9 +29392,9 @@ paths: application/json: schema: type: array - items: *201 + items: *218 examples: - default: &207 + default: &224 value: - url: https://api.github.com/orgs/github type: Organization @@ -28084,15 +29468,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: - - *202 + - *219 responses: '200': description: Response content: application/json: - schema: *201 + schema: *218 examples: - default: *203 + default: *220 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -28124,9 +29508,9 @@ paths: application/json: schema: type: array - items: *200 + items: *217 examples: - default: *204 + default: *221 headers: Link: *41 '401': *23 @@ -28149,8 +29533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *205 - - *206 + - *222 + - *223 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -28170,9 +29554,9 @@ paths: application/json: schema: type: array - items: *201 + items: *218 examples: - default: *207 + default: *224 headers: Link: *41 '401': *23 @@ -28437,14 +29821,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: - - &430 + - &447 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &431 + - &448 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -28461,7 +29845,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -28506,7 +29890,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &444 + '301': &461 description: Moved permanently content: application/json: @@ -28528,7 +29912,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &645 + - &662 name: all description: If `true`, show notifications marked as read. in: query @@ -28536,7 +29920,7 @@ paths: schema: type: boolean default: false - - &646 + - &663 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -28545,8 +29929,8 @@ paths: schema: type: boolean default: false - - *189 - - &647 + - *206 + - &664 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: @@ -28571,14 +29955,14 @@ paths: application/json: schema: type: array - items: &209 + items: &226 title: Thread description: Thread type: object properties: id: type: string - repository: &246 + repository: &266 title: Minimal Repository description: Minimal Repository type: object @@ -28917,7 +30301,7 @@ paths: type: boolean examples: - false - security_and_analysis: &377 + security_and_analysis: &394 type: - object - 'null' @@ -29090,7 +30474,7 @@ paths: - url - subscription_url examples: - default: &648 + default: &665 value: - id: '1' repository: @@ -29256,7 +30640,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &210 + - &227 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 @@ -29270,7 +30654,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *226 examples: default: value: @@ -29373,7 +30757,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *210 + - *227 responses: '205': description: Reset Content @@ -29396,7 +30780,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *210 + - *227 responses: '204': description: No content @@ -29419,13 +30803,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: - - *210 + - *227 responses: '200': description: Response content: application/json: - schema: &211 + schema: &228 title: Thread Subscription description: Thread Subscription type: object @@ -29469,7 +30853,7 @@ paths: - url - subscribed examples: - default: &212 + default: &229 value: subscribed: true ignored: false @@ -29500,7 +30884,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *210 + - *227 requestBody: required: false content: @@ -29521,9 +30905,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *228 examples: - default: *212 + default: *229 '304': *35 '403': *27 '401': *23 @@ -29546,7 +30930,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *210 + - *227 responses: '204': description: Response @@ -29641,22 +31025,9 @@ paths: application/json: schema: type: array - items: *62 + items: *67 examples: - default: &781 - 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: *230 headers: Link: example: ; rel="next" @@ -29708,7 +31079,7 @@ paths: - 3 custom_roles: type: array - items: &289 + items: &309 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -29757,7 +31128,7 @@ paths: - created_at - updated_at examples: - default: &290 + default: &310 value: id: 8030 name: Security Engineer @@ -29804,7 +31175,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: - - *76 + - *81 - name: page in: query description: The page number of results to fetch. @@ -29850,7 +31221,7 @@ paths: items: anyOf: - type: 'null' - - *108 + - *113 additionalProperties: false examples: default: @@ -29955,7 +31326,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: - - *76 + - *81 requestBody: required: true content: @@ -30021,7 +31392,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: - - *76 + - *81 requestBody: required: true content: @@ -30055,12 +31426,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: + - *81 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *140 + examples: + default: &671 + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + '403': *27 + '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: + - *81 + 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: *140 + required: + - properties + examples: + default: &672 + 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': *27 + '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 @@ -30068,13 +31540,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: - - *76 - - *169 - - *213 - - *170 - - *214 - - *215 - - *216 + - *81 + - *185 + - *231 + - *186 + - *232 + - *233 + - *234 responses: '200': description: Response when getting a billing premium request usage report @@ -30130,19 +31602,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 @@ -30185,7 +31657,7 @@ paths: '403': *27 '404': *6 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30205,23 +31677,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: - - *76 - - *169 - - *217 - - *170 - - *218 + - *81 + - *185 + - *235 + - *186 + - *236 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *219 + schema: *237 examples: - default: *220 + default: *238 '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30247,13 +31719,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: &221 + schema: &239 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -30663,7 +32135,7 @@ paths: - updated_at - archived_at examples: - default-response: &222 + default-response: &240 value: login: github id: 1 @@ -30765,7 +32237,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *76 + - *81 requestBody: required: false content: @@ -30989,18 +32461,18 @@ paths: description: Response content: application/json: - schema: *221 + schema: *239 examples: - default: *222 + default: *240 '422': description: Validation failed content: application/json: schema: oneOf: - - *223 - - *224 - '409': *107 + - *241 + - *242 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31023,7 +32495,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *76 + - *81 responses: '202': *37 '404': *6 @@ -31048,15 +32520,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *225 + schema: *243 examples: - default: *226 + default: *244 headers: Link: *41 x-github: @@ -31079,7 +32551,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: - - *76 + - *81 - *17 - *19 responses: @@ -31097,7 +32569,7 @@ paths: type: integer repository_cache_usages: type: array - items: &449 + items: &466 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -31155,7 +32627,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: - - *76 + - *81 - *17 - *19 responses: @@ -31175,7 +32647,7 @@ paths: type: array items: *42 examples: - default: *227 + default: *245 headers: Link: *41 x-github: @@ -31195,7 +32667,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: - - *76 + - *81 requestBody: required: true content: @@ -31224,6 +32696,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -31241,6 +32719,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 @@ -31264,10 +32747,193 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 + 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: + - *81 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: *43 + examples: + default: *45 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: + - *81 + - *44 + responses: + '200': + description: Response + content: + application/json: + schema: *43 + examples: + default: *246 + 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: + - *81 + - *44 + 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: + - *44 + - *81 + 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: *46 + examples: + default: *45 + 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: + - *81 + - *44 + - *47 + responses: + '200': + description: Response + content: + application/json: + schema: *46 + examples: + default: *247 + 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: + - *81 + - *44 + - *47 + responses: + '204': + description: Response + x-github: githubCloudOnly: false + enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": @@ -31282,7 +32948,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: - - *76 + - *81 responses: '200': description: Response @@ -31298,9 +32964,9 @@ paths: type: integer images: type: array - items: *43 + items: *48 examples: - default: *44 + default: *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31318,7 +32984,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: - - *76 + - *81 responses: '200': description: Response @@ -31334,9 +33000,9 @@ paths: type: integer images: type: array - items: *43 + items: *48 examples: - default: *44 + default: *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31353,15 +33019,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *228 + schema: *248 examples: - default: *229 + default: *249 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31379,7 +33045,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: - - *76 + - *81 responses: '200': description: Response @@ -31395,9 +33061,9 @@ paths: type: integer machine_specs: type: array - items: *45 + items: *50 examples: - default: *230 + default: *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31415,7 +33081,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: - - *76 + - *81 responses: '200': description: Response @@ -31459,8 +33125,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: - - *76 - - *47 + - *81 + - *52 responses: '200': description: Response @@ -31468,7 +33134,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 headers: Link: *41 x-github: @@ -31488,8 +33154,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: - - *76 - - *47 + - *81 + - *52 requestBody: required: true content: @@ -31515,6 +33181,12 @@ 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 + - 'null' examples: default: value: @@ -31529,7 +33201,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -31545,8 +33217,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: - - *76 - - *47 + - *81 + - *52 responses: '202': description: Response @@ -31554,7 +33226,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -31574,13 +33246,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: - - *76 + - *81 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &231 + schema: &251 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -31594,7 +33266,7 @@ paths: required: - include_claim_keys examples: - default: &232 + default: &252 value: include_claim_keys: - repo @@ -31616,20 +33288,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: - - *76 + - *81 requestBody: required: true content: application/json: - schema: *231 + schema: *251 examples: - default: *232 + default: *252 responses: '201': description: Empty response content: application/json: - schema: &257 + schema: &277 title: Empty Object description: An object without any properties. type: object @@ -31659,7 +33331,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: - - *76 + - *81 responses: '200': description: Response @@ -31668,7 +33340,7 @@ paths: schema: type: object properties: - enabled_repositories: &234 + enabled_repositories: &254 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -31681,9 +33353,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: *49 - selected_actions_url: *233 - sha_pinning_required: *50 + allowed_actions: *54 + selected_actions_url: *253 + sha_pinning_required: *55 required: - enabled_repositories examples: @@ -31713,7 +33385,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: - - *76 + - *81 responses: '204': description: Response @@ -31724,9 +33396,9 @@ paths: schema: type: object properties: - enabled_repositories: *234 - allowed_actions: *49 - sha_pinning_required: *50 + enabled_repositories: *254 + allowed_actions: *54 + sha_pinning_required: *55 required: - enabled_repositories examples: @@ -31754,13 +33426,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *235 + schema: *255 examples: response: summary: Example response @@ -31786,12 +33458,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: - - *76 + - *81 requestBody: required: true content: application/json: - schema: *236 + schema: *256 examples: application/json: value: @@ -31801,7 +33473,7 @@ paths: description: No content '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 x-github: enabledForGitHubApps: true @@ -31821,15 +33493,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *51 + schema: *56 examples: - default: *237 + default: *257 '404': *6 x-github: enabledForGitHubApps: true @@ -31848,7 +33520,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: - - *76 + - *81 responses: '204': description: Response @@ -31858,7 +33530,7 @@ paths: required: true content: application/json: - schema: *51 + schema: *56 examples: default: summary: Set approval policy to first time contributors @@ -31880,15 +33552,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *238 + schema: *258 examples: - default: *52 + default: *57 '403': *27 '404': *6 x-github: @@ -31906,14 +33578,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: - - *76 + - *81 requestBody: required: true content: application/json: - schema: *239 + schema: *259 examples: - default: *52 + default: *57 responses: '204': description: Empty response for successful settings update @@ -31943,7 +33615,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: - - *76 + - *81 - *17 - *19 responses: @@ -31961,9 +33633,9 @@ paths: type: number repositories: type: array - items: *67 + items: *72 examples: - default: &241 + default: &261 value: total_count: 1 repositories: @@ -32103,7 +33775,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: - - *76 + - *81 responses: '204': description: Response @@ -32147,8 +33819,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: - - *76 - - &240 + - *81 + - &260 name: repository_id description: The unique identifier of the repository. in: path @@ -32176,8 +33848,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: - - *76 - - *240 + - *81 + - *260 responses: '204': description: Response @@ -32200,15 +33872,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *54 + schema: *59 examples: - default: *55 + default: *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32231,7 +33903,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: - - *76 + - *81 responses: '204': description: Response @@ -32239,9 +33911,9 @@ paths: required: false content: application/json: - schema: *54 + schema: *59 examples: - selected_actions: *55 + selected_actions: *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32261,7 +33933,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: - - *76 + - *81 responses: '200': description: Response @@ -32309,7 +33981,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: - - *76 + - *81 requestBody: required: true content: @@ -32336,7 +34008,7 @@ paths: description: No content '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 x-github: enabledForGitHubApps: true @@ -32356,7 +34028,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: - - *76 + - *81 - *17 - *19 responses: @@ -32371,9 +34043,9 @@ paths: type: integer repositories: type: array - items: *67 + items: *72 examples: - default: *241 + default: *261 '403': *27 '404': *6 x-github: @@ -32393,7 +34065,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: - - *76 + - *81 requestBody: required: true content: @@ -32441,14 +34113,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: - - *76 - - *240 + - *81 + - *260 responses: '204': description: No content '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 x-github: enabledForGitHubApps: true @@ -32468,14 +34140,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: - - *76 - - *240 + - *81 + - *260 responses: '204': description: No content '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 x-github: enabledForGitHubApps: true @@ -32497,15 +34169,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *242 + schema: *262 examples: - default: *58 + default: *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32526,7 +34198,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: - - *76 + - *81 responses: '204': description: Success response @@ -32537,9 +34209,9 @@ paths: required: false content: application/json: - schema: *243 + schema: *263 examples: - default: *58 + default: *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32559,7 +34231,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: - - *76 + - *81 - *17 - *19 - name: visible_to_repository @@ -32584,7 +34256,7 @@ paths: type: number runner_groups: type: array - items: &244 + items: &264 type: object properties: id: @@ -32701,7 +34373,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: - - *76 + - *81 requestBody: required: true content: @@ -32774,9 +34446,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *264 examples: - default: &245 + default: &265 value: id: 2 name: octo-runner-group @@ -32811,14 +34483,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: - - *76 - - *61 + - *81 + - *66 responses: '200': description: Response content: application/json: - schema: *244 + schema: *264 examples: default: value: @@ -32854,8 +34526,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: - - *76 - - *61 + - *81 + - *66 requestBody: required: true content: @@ -32911,9 +34583,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *264 examples: - default: *245 + default: *265 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32932,8 +34604,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: - - *76 - - *61 + - *81 + - *66 responses: '204': description: Response @@ -32956,8 +34628,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: - - *76 - - *61 + - *81 + - *66 - *17 - *19 responses: @@ -32977,7 +34649,7 @@ paths: type: array items: *42 examples: - default: *227 + default: *245 headers: Link: *41 x-github: @@ -32999,8 +34671,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: - - *76 - - *61 + - *81 + - *66 - *19 - *17 responses: @@ -33018,9 +34690,9 @@ paths: type: number repositories: type: array - items: *246 + items: *266 examples: - default: &768 + default: &787 value: total_count: 1 repositories: @@ -33272,8 +34944,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: - - *76 - - *61 + - *81 + - *66 requestBody: required: true content: @@ -33317,9 +34989,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: - - *76 - - *61 - - *240 + - *81 + - *66 + - *260 responses: '204': description: Response @@ -33341,9 +35013,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: - - *76 - - *61 - - *240 + - *81 + - *66 + - *260 responses: '204': description: Response @@ -33366,8 +35038,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: - - *76 - - *61 + - *81 + - *66 - *17 - *19 responses: @@ -33385,9 +35057,9 @@ paths: type: number runners: type: array - items: *65 + items: *70 examples: - default: *66 + default: *71 headers: Link: *41 x-github: @@ -33408,8 +35080,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: - - *76 - - *61 + - *81 + - *66 requestBody: required: true content: @@ -33453,9 +35125,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: - - *76 - - *61 - - *64 + - *81 + - *66 + - *69 responses: '204': description: Response @@ -33477,9 +35149,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: - - *76 - - *61 - - *64 + - *81 + - *66 + - *69 responses: '204': description: Response @@ -33509,7 +35181,7 @@ paths: in: query schema: type: string - - *76 + - *81 - *17 - *19 responses: @@ -33527,9 +35199,9 @@ paths: type: integer runners: type: array - items: *65 + items: *70 examples: - default: *66 + default: *71 headers: Link: *41 x-github: @@ -33553,7 +35225,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: - - *76 + - *81 responses: '200': description: Response @@ -33561,9 +35233,9 @@ paths: application/json: schema: type: array - items: *247 + items: *267 examples: - default: *248 + default: *268 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33585,7 +35257,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: - - *76 + - *81 requestBody: required: true content: @@ -33628,10 +35300,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *249 + '201': *269 '404': *6 '422': *7 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33659,15 +35331,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: - - *76 + - *81 responses: '201': description: Response content: application/json: - schema: *68 + schema: *73 examples: - default: *250 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33695,15 +35367,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: - - *76 + - *81 responses: '201': description: Response content: application/json: - schema: *68 + schema: *73 examples: - default: *251 + default: *271 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33725,16 +35397,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: - - *76 - - *64 + - *81 + - *69 responses: '200': description: Response content: application/json: - schema: *65 + schema: *70 examples: - default: *252 + default: *272 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33755,8 +35427,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: - - *76 - - *64 + - *81 + - *69 responses: '204': description: Response @@ -33782,10 +35454,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: - - *76 - - *64 + - *81 + - *69 responses: - '200': *70 + '200': *75 '404': *6 x-github: githubCloudOnly: false @@ -33807,8 +35479,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: - - *76 - - *64 + - *81 + - *69 requestBody: required: true content: @@ -33832,7 +35504,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -33856,8 +35528,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: - - *76 - - *64 + - *81 + - *69 requestBody: required: true content: @@ -33882,7 +35554,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -33906,10 +35578,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: - - *76 - - *64 + - *81 + - *69 responses: - '200': *253 + '200': *273 '404': *6 x-github: githubCloudOnly: false @@ -33936,11 +35608,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: - - *76 - - *64 - - *254 + - *81 + - *69 + - *274 responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -33965,7 +35637,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *76 + - *81 - *17 - *19 responses: @@ -33983,7 +35655,7 @@ paths: type: integer secrets: type: array - items: &255 + items: &275 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -34058,13 +35730,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: &469 + schema: &486 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -34099,7 +35771,7 @@ paths: - key_id - key examples: - default: &470 + default: &487 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -34124,8 +35796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *76 - - &256 + - *81 + - &276 name: secret_name description: The name of the secret. in: path @@ -34137,7 +35809,7 @@ paths: description: Response content: application/json: - schema: *255 + schema: *275 examples: default: value: @@ -34167,8 +35839,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -34225,7 +35897,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -34251,8 +35923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 responses: '204': description: Response @@ -34278,8 +35950,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: - - *76 - - *256 + - *81 + - *276 - *19 - *17 responses: @@ -34297,9 +35969,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: &260 + default: &280 value: total_count: 1 repositories: @@ -34391,8 +36063,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: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -34444,8 +36116,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -34478,8 +36150,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -34511,8 +36183,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *76 - - &454 + - *81 + - &471 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)." @@ -34536,7 +36208,7 @@ paths: type: integer variables: type: array - items: &258 + items: &278 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -34626,7 +36298,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *76 + - *81 requestBody: required: true content: @@ -34674,7 +36346,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -34699,8 +36371,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *76 - - &259 + - *81 + - &279 name: name description: The name of the variable. in: path @@ -34712,7 +36384,7 @@ paths: description: Response content: application/json: - schema: *258 + schema: *278 examples: default: value: @@ -34742,8 +36414,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *76 - - *259 + - *81 + - *279 requestBody: required: true content: @@ -34805,8 +36477,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *76 - - *259 + - *81 + - *279 responses: '204': description: Response @@ -34832,8 +36504,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: - - *76 - - *259 + - *81 + - *279 - *19 - *17 responses: @@ -34851,9 +36523,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: *260 + default: *280 '409': description: Response when the visibility of the variable is not set to `selected` @@ -34879,8 +36551,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: - - *76 - - *259 + - *81 + - *279 requestBody: required: true content: @@ -34929,8 +36601,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: - - *76 - - *259 + - *81 + - *279 - name: repository_id in: path required: true @@ -34964,8 +36636,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: - - *76 - - *259 + - *81 + - *279 - name: repository_id in: path required: true @@ -34996,15 +36668,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *75 + schema: *80 examples: - default: *74 + default: *79 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35023,19 +36695,19 @@ paths: required: true content: application/json: - schema: *261 + schema: *281 examples: - default: *74 + default: *79 parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *75 + schema: *80 examples: - default: *74 + default: *79 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35051,7 +36723,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *76 + - *81 responses: '204': description: Response @@ -35074,7 +36746,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *76 + - *81 requestBody: required: true content: @@ -35216,7 +36888,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *76 + - *81 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -35300,9 +36972,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *97 - - *98 - - *76 + - *102 + - *103 + - *81 requestBody: required: true content: @@ -35325,12 +36997,12 @@ paths: required: - subject_digests examples: - default: &796 + default: &814 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &797 + withPredicateType: &815 value: subject_digests: - sha256:abc123 @@ -35389,7 +37061,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &798 + default: &816 value: attestations_subject_digests: - sha256:abc: @@ -35498,7 +37170,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *76 + - *81 requestBody: required: true content: @@ -35563,7 +37235,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *76 + - *81 - name: subject_digest description: Subject Digest in: path @@ -35582,6 +37254,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 + - *102 + - *103 + - *81 + - 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 @@ -35594,7 +37317,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id parameters: - - *76 + - *81 - name: attestation_id description: Attestation ID in: path @@ -35630,9 +37353,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations parameters: - *17 - - *97 - - *98 - - *76 + - *102 + - *103 + - *81 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -35685,7 +37408,7 @@ paths: initiator: type: string examples: - default: &483 + default: &500 value: attestations: - bundle: @@ -35803,7 +37526,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: - - *76 + - *81 - 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). @@ -35811,10 +37534,10 @@ paths: required: false schema: type: string - - *262 - - *263 - - *264 - - *265 + - *282 + - *283 + - *284 + - *285 - *17 responses: '200': @@ -35823,9 +37546,9 @@ paths: application/json: schema: type: array - items: *266 + items: *286 examples: - default: *267 + default: *287 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35842,7 +37565,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *76 + - *81 - *17 - *19 responses: @@ -35854,7 +37577,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35873,8 +37596,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: If the user is blocked @@ -35899,8 +37622,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -35920,8 +37643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -35947,17 +37670,17 @@ paths: category: orgs subcategory: bypass-requests parameters: - - *76 - - &270 + - *81 + - &290 name: repository_name description: The name of the repository to filter on. in: query schema: type: string - - *92 - - *93 - - *94 - - *95 + - *97 + - *98 + - *99 + - *100 - *17 - *19 responses: @@ -35967,9 +37690,9 @@ paths: application/json: schema: type: array - items: *268 + items: *288 examples: - default: *269 + default: *289 '404': *6 '500': *38 "/orgs/{org}/bypass-requests/secret-scanning": @@ -35992,12 +37715,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *76 - - *270 - - *92 - - *93 - - *94 - - *95 + - *81 + - *290 + - *97 + - *98 + - *99 + - *100 - *17 - *19 responses: @@ -36007,9 +37730,9 @@ paths: application/json: schema: type: array - items: *271 + items: *291 examples: - default: *272 + default: *292 '404': *6 '500': *38 "/orgs/{org}/campaigns": @@ -36028,15 +37751,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *76 + - *81 - *19 - *17 - - *99 + - *104 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &274 + schema: &294 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -36062,7 +37785,7 @@ paths: application/json: schema: type: array - items: &275 + items: &295 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -36093,7 +37816,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *273 + items: *293 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -36112,7 +37835,7 @@ paths: - string - 'null' format: date-time - state: *274 + state: *294 contact_link: description: The contact link of the campaign. type: @@ -36210,7 +37933,7 @@ paths: headers: Link: *41 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36234,7 +37957,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *76 + - *81 requestBody: required: true content: @@ -36281,7 +38004,9 @@ paths: format: uri code_scanning_alerts: description: The code scanning alerts to include in this campaign - type: array + type: + - array + - 'null' minItems: 1 items: type: object @@ -36308,7 +38033,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -36329,9 +38058,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *295 examples: - default: &276 + default: &296 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -36380,7 +38109,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36402,7 +38131,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *76 + - *81 - name: campaign_number description: The campaign number. in: path @@ -36414,16 +38143,16 @@ paths: description: Response content: application/json: - schema: *275 + schema: *295 examples: - default: *276 + default: *296 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36444,7 +38173,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign parameters: - - *76 + - *81 - name: campaign_number description: The campaign number. in: path @@ -36494,7 +38223,7 @@ paths: - string - 'null' format: uri - state: *274 + state: *294 examples: default: value: @@ -36504,9 +38233,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *295 examples: - default: *276 + default: *296 '400': description: Bad Request content: @@ -36518,7 +38247,7 @@ paths: content: application/json: schema: *3 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36539,7 +38268,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *76 + - *81 - name: campaign_number description: The campaign number. in: path @@ -36550,7 +38279,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36572,20 +38301,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: - - *76 - - *277 - - *278 - - *97 - - *98 + - *81 + - *297 + - *298 + - *102 + - *103 - *19 - *17 - - *99 + - *104 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: *279 + schema: *299 - name: sort description: The property by which to sort the results. in: query @@ -36601,7 +38330,7 @@ paths: be returned. in: query required: false - schema: &508 + schema: &525 type: string description: Severity of a code scanning alert. enum: @@ -36619,13 +38348,13 @@ paths: application/json: schema: type: array - items: *280 + items: *300 examples: - default: *281 + default: *301 headers: Link: *41 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36647,7 +38376,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: - - *76 + - *81 - name: target_type in: query description: The target type of the code security configuration @@ -36666,8 +38395,8 @@ paths: schema: type: integer default: 30 - - *97 - - *98 + - *102 + - *103 responses: '200': description: Response @@ -36675,7 +38404,7 @@ paths: application/json: schema: type: array - items: *103 + items: *108 examples: default: value: @@ -36758,7 +38487,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *76 + - *81 requestBody: required: true content: @@ -36836,7 +38565,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *282 + code_scanning_options: *302 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -36845,7 +38574,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *106 + code_scanning_default_setup_options: *111 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -36977,9 +38706,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *103 + schema: *108 examples: - default: *283 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37001,15 +38730,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *284 + schema: *304 examples: - default: *285 + default: *305 '304': *35 '403': *27 '404': *6 @@ -37035,7 +38764,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *76 + - *81 requestBody: required: true content: @@ -37061,11 +38790,11 @@ paths: - 32 - 91 responses: - '204': *129 + '204': *139 '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37087,16 +38816,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *76 - - *105 + - *81 + - *110 responses: '200': description: Response content: application/json: - schema: *103 + schema: *108 examples: - default: *283 + default: *303 '304': *35 '403': *27 '404': *6 @@ -37120,8 +38849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *76 - - *105 + - *81 + - *110 requestBody: required: true content: @@ -37200,7 +38929,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *106 + code_scanning_default_setup_options: *111 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -37318,7 +39047,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *103 + schema: *108 examples: default: value: @@ -37377,14 +39106,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *76 - - *105 + - *81 + - *110 responses: - '204': *129 + '204': *139 '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37408,8 +39137,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *76 - - *105 + - *81 + - *110 requestBody: required: true content: @@ -37472,8 +39201,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: - - *76 - - *105 + - *81 + - *110 requestBody: required: true content: @@ -37513,12 +39242,12 @@ paths: - none - private_and_internal - public - configuration: *103 + configuration: *108 examples: default: value: default_for_new_repos: all - configuration: *283 + configuration: *303 '403': *27 '404': *6 x-github: @@ -37542,8 +39271,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: - - *76 - - *105 + - *81 + - *110 - 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)." @@ -37552,8 +39281,8 @@ paths: schema: type: integer default: 30 - - *97 - - *98 + - *102 + - *103 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -37571,13 +39300,13 @@ paths: application/json: schema: type: array - items: *286 + items: *306 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *287 + repository: *307 '403': *27 '404': *6 x-github: @@ -37601,7 +39330,7 @@ paths: parameters: - *17 - *19 - - *76 + - *81 responses: '200': description: Response @@ -37617,7 +39346,7 @@ paths: type: integer codespaces: type: array - items: &336 + items: &354 type: object title: Codespace description: A codespace. @@ -37648,11 +39377,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *246 + repository: *266 machine: anyOf: - type: 'null' - - &537 + - &554 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -37939,7 +39668,7 @@ paths: - pulls_url - recent_folders examples: - default: &337 + default: &355 value: total_count: 3 codespaces: @@ -38371,7 +40100,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *76 + - *81 deprecated: true requestBody: required: true @@ -38438,7 +40167,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: - - *76 + - *81 deprecated: true requestBody: required: true @@ -38493,7 +40222,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *76 + - *81 requestBody: required: true content: @@ -38545,7 +40274,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *76 + - *81 - *17 - *19 responses: @@ -38563,7 +40292,7 @@ paths: type: integer secrets: type: array - items: &288 + items: &308 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -38604,7 +40333,7 @@ paths: - updated_at - visibility examples: - default: &538 + default: &555 value: total_count: 2 secrets: @@ -38636,13 +40365,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: &539 + schema: &556 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -38677,7 +40406,7 @@ paths: - key_id - key examples: - default: &540 + default: &557 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -38700,16 +40429,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 responses: '200': description: Response content: application/json: - schema: *288 + schema: *308 examples: - default: &542 + default: &559 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -38736,8 +40465,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: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -38792,7 +40521,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -38818,8 +40547,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 responses: '204': description: Response @@ -38844,8 +40573,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: - - *76 - - *256 + - *81 + - *276 - *19 - *17 responses: @@ -38863,9 +40592,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: *260 + default: *280 '404': *6 x-github: githubCloudOnly: false @@ -38887,8 +40616,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: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -38938,8 +40667,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -38972,8 +40701,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -39012,7 +40741,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: - - *76 + - *81 responses: '200': description: OK @@ -39153,7 +40882,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: - - *76 + - *81 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -39176,9 +40905,9 @@ paths: currently being billed. seats: type: array - items: *120 + items: *130 examples: - default: *121 + default: *131 headers: Link: *41 '500': *38 @@ -39214,7 +40943,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: - - *76 + - *81 requestBody: content: application/json: @@ -39292,7 +41021,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: - - *76 + - *81 requestBody: content: application/json: @@ -39372,7 +41101,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: - - *76 + - *81 requestBody: content: application/json: @@ -39449,7 +41178,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: - - *76 + - *81 requestBody: content: application/json: @@ -39530,7 +41259,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: - - *76 + - *81 - 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`). @@ -39562,13 +41291,13 @@ paths: application/json: schema: type: array - items: *171 + items: *187 examples: - default: *172 + default: *188 '500': *38 '403': *27 '404': *6 - '422': *173 + '422': *189 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39590,7 +41319,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: - - *76 + - *81 - *17 - name: page description: Page token @@ -39749,7 +41478,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: - - *76 + - *81 - name: credential_id in: path required: true @@ -39780,7 +41509,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: - - *76 + - *81 responses: '200': description: Response - list of custom role names @@ -39796,7 +41525,7 @@ paths: - 3 custom_roles: type: array - items: *289 + items: *309 examples: default: value: @@ -39883,12 +41612,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *76 + - *81 requestBody: required: true content: application/json: - schema: &292 + schema: &312 type: object properties: name: @@ -39930,9 +41659,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '422': *15 '404': *6 x-github: @@ -39956,8 +41685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *76 - - &291 + - *81 + - &311 name: role_id description: The unique identifier of the role. in: path @@ -39969,9 +41698,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '404': *6 x-github: githubCloudOnly: true @@ -39993,13 +41722,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *76 - - *291 + - *81 + - *311 requestBody: required: true content: application/json: - schema: &293 + schema: &313 type: object properties: name: @@ -40038,9 +41767,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '422': *15 '404': *6 x-github: @@ -40064,8 +41793,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *76 - - *291 + - *81 + - *311 responses: '204': description: Response @@ -40093,12 +41822,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: - - *76 + - *81 requestBody: required: true content: application/json: - schema: *292 + schema: *312 examples: default: value: @@ -40112,9 +41841,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '422': *15 '404': *6 x-github: @@ -40144,16 +41873,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: - - *76 - - *291 + - *81 + - *311 responses: '200': description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '404': *6 x-github: githubCloudOnly: true @@ -40181,13 +41910,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: - - *76 - - *291 + - *81 + - *311 requestBody: required: true content: application/json: - schema: *293 + schema: *313 examples: default: value: @@ -40202,9 +41931,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '422': *15 '404': *6 x-github: @@ -40234,8 +41963,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: - - *76 - - *291 + - *81 + - *311 responses: '204': description: Response @@ -40263,12 +41992,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *76 - - *294 - - *295 - - *296 - - *297 - - *298 + - *81 + - *314 + - *315 + - *316 + - *317 + - *318 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -40306,13 +42035,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *299 - - *300 - - *99 - - *97 - - *98 - - *301 - - *302 + - *319 + - *320 + - *104 + - *102 + - *103 - *17 responses: '200': @@ -40321,9 +42048,9 @@ paths: application/json: schema: type: array - items: *303 + items: *321 examples: - default: *304 + default: *322 '304': *35 '400': *14 '403': *27 @@ -40349,7 +42076,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *76 + - *81 - *17 - *19 responses: @@ -40367,7 +42094,7 @@ paths: type: integer secrets: type: array - items: &305 + items: &323 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -40440,13 +42167,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: &565 + schema: &582 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -40465,7 +42192,7 @@ paths: - key_id - key examples: - default: &566 + default: &583 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -40488,14 +42215,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 responses: '200': description: Response content: application/json: - schema: *305 + schema: *323 examples: default: value: @@ -40523,8 +42250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -40583,7 +42310,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -40607,8 +42334,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 responses: '204': description: Response @@ -40632,8 +42359,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: - - *76 - - *256 + - *81 + - *276 - *19 - *17 responses: @@ -40651,9 +42378,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: *260 + default: *280 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40674,8 +42401,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: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -40725,8 +42452,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -40757,8 +42484,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -40794,8 +42521,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *76 - - &574 + - *81 + - &591 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -40803,7 +42530,7 @@ paths: required: false schema: type: string - - &575 + - &592 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -40811,7 +42538,7 @@ paths: required: false schema: type: string - - &576 + - &593 name: time_period description: |- The time period to filter by. @@ -40827,7 +42554,7 @@ paths: - week - month default: month - - &577 + - &594 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -40842,7 +42569,7 @@ paths: - denied - all default: all - - *270 + - *290 - *17 - *19 responses: @@ -40852,7 +42579,7 @@ paths: application/json: schema: type: array - items: &578 + items: &595 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -41015,7 +42742,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &579 + default: &596 value: - id: 21 number: 42 @@ -41101,12 +42828,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *76 - - *270 - - *92 - - *93 - - *94 - - &580 + - *81 + - *290 + - *97 + - *98 + - *99 + - &597 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -41132,7 +42859,7 @@ paths: application/json: schema: type: array - items: &581 + items: &598 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -41246,7 +42973,7 @@ paths: - array - 'null' description: The responses to the dismissal request. - items: *96 + items: *101 url: type: string format: uri @@ -41259,7 +42986,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &582 + default: &599 value: - id: 21 number: 42 @@ -41339,7 +43066,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: - - *76 + - *81 responses: '200': description: Response @@ -41347,7 +43074,7 @@ paths: application/json: schema: type: array - items: &346 + items: &364 title: Package description: A software package type: object @@ -41400,7 +43127,7 @@ paths: repository: anyOf: - type: 'null' - - *246 + - *266 created_at: type: string format: date-time @@ -41418,7 +43145,7 @@ paths: - created_at - updated_at examples: - default: &347 + default: &365 value: - id: 197 name: hello_docker @@ -41496,7 +43223,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *76 + - *81 - *17 - *19 responses: @@ -41506,7 +43233,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: 200-response: value: @@ -41579,7 +43306,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *76 + - *81 - name: group_id description: The unique identifier of the group. in: path @@ -41605,7 +43332,7 @@ paths: description: Response content: application/json: - schema: &425 + schema: &442 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -41695,7 +43422,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &426 + default: &443 value: group_id: '123' group_name: Octocat admins @@ -41733,7 +43460,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: - - *76 + - *81 - *17 - name: page description: Page token @@ -41750,7 +43477,7 @@ paths: description: Response content: application/json: - schema: &423 + schema: &440 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -41790,7 +43517,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &424 + default: &441 value: groups: - group_id: '123' @@ -41824,7 +43551,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *76 + - *81 - *17 - *19 responses: @@ -41834,7 +43561,7 @@ paths: application/json: schema: type: array - items: &328 + items: &346 title: Organization Invitation description: Organization Invitation type: object @@ -41888,7 +43615,7 @@ paths: - invitation_teams_url - node_id examples: - default: &329 + default: &347 value: - id: 1 login: monalisa @@ -41947,7 +43674,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: - - *76 + - *81 responses: '200': description: Response @@ -41955,7 +43682,7 @@ paths: application/json: schema: type: array - items: &378 + items: &395 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -41969,7 +43696,7 @@ paths: - name - description examples: - default: &379 + default: &396 value: - name: add_assignee description: Assign or remove a user @@ -42000,7 +43727,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *76 + - *81 - *17 - *19 responses: @@ -42010,7 +43737,7 @@ paths: application/json: schema: type: array - items: &306 + items: &324 title: Org Hook description: Org Hook type: object @@ -42131,7 +43858,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *76 + - *81 requestBody: required: true content: @@ -42193,9 +43920,9 @@ paths: description: Response content: application/json: - schema: *306 + schema: *324 examples: - default: &307 + default: &325 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -42239,8 +43966,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *76 - - &308 + - *81 + - &326 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. @@ -42253,9 +43980,9 @@ paths: description: Response content: application/json: - schema: *306 + schema: *324 examples: - default: *307 + default: *325 '404': *6 x-github: githubCloudOnly: false @@ -42276,8 +44003,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *76 - - *308 + - *81 + - *326 requestBody: required: false content: @@ -42323,7 +44050,7 @@ paths: description: Response content: application/json: - schema: *306 + schema: *324 examples: default: value: @@ -42362,8 +44089,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *76 - - *308 + - *81 + - *326 responses: '204': description: Response @@ -42388,8 +44115,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: - - *76 - - *308 + - *81 + - *326 responses: '200': description: Response @@ -42417,8 +44144,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: - - *76 - - *308 + - *81 + - *326 requestBody: required: false content: @@ -42466,10 +44193,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *76 - - *308 + - *81 + - *326 - *17 - - *309 + - *327 responses: '200': description: Response @@ -42477,9 +44204,9 @@ paths: application/json: schema: type: array - items: *310 + items: *328 examples: - default: *311 + default: *329 '400': *14 '422': *15 x-github: @@ -42502,17 +44229,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: - - *76 - - *308 + - *81 + - *326 - *16 responses: '200': description: Response content: application/json: - schema: *312 + schema: *330 examples: - default: *313 + default: *331 '400': *14 '422': *15 x-github: @@ -42535,8 +44262,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: - - *76 - - *308 + - *81 + - *326 - *16 responses: '202': *37 @@ -42562,8 +44289,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *76 - - *308 + - *81 + - *326 responses: '204': description: Response @@ -42585,8 +44312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *76 - - &318 + - *81 + - &336 name: actor_type in: path description: The type of the actor @@ -42599,14 +44326,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &319 + - &337 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &314 + - &332 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`.' @@ -42614,7 +44341,7 @@ paths: required: true schema: type: string - - &315 + - &333 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) @@ -42625,7 +44352,7 @@ paths: type: string - *19 - *17 - - *99 + - *104 - name: sort description: The property to sort the results by. in: query @@ -42708,13 +44435,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *76 - - *314 - - *315 + - *81 + - *332 + - *333 - *19 - *17 - - *99 - - &324 + - *104 + - &342 name: sort description: The property to sort the results by. in: query @@ -42793,15 +44520,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *76 - - *314 - - *315 + - *81 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &316 + schema: &334 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -42817,7 +44544,7 @@ paths: type: integer format: int64 examples: - default: &317 + default: &335 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -42837,24 +44564,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *76 - - &320 + - *81 + - &338 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *314 - - *315 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *316 + schema: *334 examples: - default: *317 + default: *335 x-github: enabledForGitHubApps: true category: orgs @@ -42872,19 +44599,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *76 - - *314 - - *315 - - *318 - - *319 + - *81 + - *332 + - *333 + - *336 + - *337 responses: '200': description: Response content: application/json: - schema: *316 + schema: *334 examples: - default: *317 + default: *335 x-github: enabledForGitHubApps: true category: orgs @@ -42901,10 +44628,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *76 - - *314 - - *315 - - &321 + - *81 + - *332 + - *333 + - &339 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -42917,7 +44644,7 @@ paths: description: Response content: application/json: - schema: &322 + schema: &340 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -42933,7 +44660,7 @@ paths: type: integer format: int64 examples: - default: &323 + default: &341 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -42969,19 +44696,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *76 - - *320 - - *314 - - *315 - - *321 + - *81 + - *338 + - *332 + - *333 + - *339 responses: '200': description: Response content: application/json: - schema: *322 + schema: *340 examples: - default: *323 + default: *341 x-github: enabledForGitHubApps: true category: orgs @@ -42998,20 +44725,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *76 - - *318 - - *319 - - *314 - - *315 - - *321 + - *81 + - *336 + - *337 + - *332 + - *333 + - *339 responses: '200': description: Response content: application/json: - schema: *322 + schema: *340 examples: - default: *323 + default: *341 x-github: enabledForGitHubApps: true category: orgs @@ -43028,14 +44755,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *76 - - *320 - - *314 - - *315 + - *81 + - *338 + - *332 + - *333 - *19 - *17 - - *99 - - *324 + - *104 + - *342 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -43111,7 +44838,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: - - *76 + - *81 responses: '200': description: Response @@ -43119,7 +44846,7 @@ paths: application/json: schema: *20 examples: - default: &613 + default: &630 value: id: 1 account: @@ -43188,7 +44915,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *76 + - *81 - *17 - *19 responses: @@ -43277,7 +45004,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *76 + - *81 responses: '200': description: Response @@ -43285,12 +45012,12 @@ paths: application/json: schema: anyOf: - - &326 + - &344 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &325 + limit: &343 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -43318,7 +45045,7 @@ paths: properties: {} additionalProperties: false examples: - default: &327 + default: &345 value: limit: collaborators_only origin: organization @@ -43342,18 +45069,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *76 + - *81 requestBody: required: true content: application/json: - schema: &614 + schema: &631 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *325 + limit: *343 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -43378,9 +45105,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *344 examples: - default: *327 + default: *345 '422': *15 x-github: githubCloudOnly: false @@ -43398,7 +45125,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *76 + - *81 responses: '204': description: Response @@ -43424,7 +45151,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *76 + - *81 - *17 - *19 - name: role @@ -43458,9 +45185,9 @@ paths: application/json: schema: type: array - items: *328 + items: *346 examples: - default: *329 + default: *347 headers: Link: *41 '404': *6 @@ -43484,7 +45211,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *76 + - *81 requestBody: required: false content: @@ -43538,7 +45265,7 @@ paths: description: Response content: application/json: - schema: *328 + schema: *346 examples: default: value: @@ -43594,8 +45321,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *76 - - &330 + - *81 + - &348 name: invitation_id description: The unique identifier of the invitation. in: path @@ -43628,8 +45355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *76 - - *330 + - *81 + - *348 - *17 - *19 responses: @@ -43639,9 +45366,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: &345 + default: &363 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -43676,7 +45403,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: - - *76 + - *81 responses: '200': description: Response @@ -43684,7 +45411,7 @@ paths: application/json: schema: type: array - items: *331 + items: *349 examples: default: value: @@ -43722,7 +45449,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: - - *76 + - *81 requestBody: required: true content: @@ -43772,9 +45499,9 @@ paths: description: Response content: application/json: - schema: *331 + schema: *349 examples: - default: &332 + default: &350 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -43806,8 +45533,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: - - *76 - - &333 + - *81 + - &351 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -43863,9 +45590,9 @@ paths: description: Response content: application/json: - schema: *331 + schema: *349 examples: - default: *332 + default: *350 '404': *6 '422': *7 x-github: @@ -43889,8 +45616,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: - - *76 - - *333 + - *81 + - *351 responses: '204': description: Response @@ -43923,7 +45650,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: - - *76 + - *81 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -43953,7 +45680,7 @@ paths: - closed - all default: open - - *334 + - *352 - name: type description: Can be the name of an issue type. in: query @@ -43971,8 +45698,8 @@ paths: - updated - comments default: created - - *99 - - *189 + - *104 + - *206 - *17 - *19 responses: @@ -43982,9 +45709,9 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: *335 + default: *353 headers: Link: *41 '404': *6 @@ -44006,7 +45733,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *76 + - *81 - 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) @@ -44044,7 +45771,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '422': *15 @@ -44064,8 +45791,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response if requester is an organization member and user is @@ -44099,8 +45826,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -44126,8 +45853,8 @@ paths: parameters: - *17 - *19 - - *76 - - *178 + - *81 + - *194 responses: '200': description: Response @@ -44143,9 +45870,9 @@ paths: type: integer codespaces: type: array - items: *336 + items: *354 examples: - default: *337 + default: *355 '304': *35 '500': *38 '401': *23 @@ -44170,9 +45897,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *76 - - *178 - - &338 + - *81 + - *194 + - &356 name: codespace_name in: path required: true @@ -44205,17 +45932,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: - - *76 - - *178 - - *338 + - *81 + - *194 + - *356 responses: '200': description: Response content: application/json: - schema: *336 + schema: *354 examples: - default: &536 + default: &553 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -44388,14 +46115,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: - - *76 - - *178 + - *81 + - *194 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *120 + schema: *130 examples: default: value: @@ -44464,14 +46191,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *76 - - *178 + - *81 + - *194 responses: '200': description: Response content: application/json: - schema: &339 + schema: &357 title: Org Membership description: Org Membership type: object @@ -44520,7 +46247,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *62 + organization: *67 user: anyOf: - type: 'null' @@ -44540,7 +46267,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &340 + response-if-user-has-an-active-admin-membership-with-organization: &358 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -44608,8 +46335,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *76 - - *178 + - *81 + - *194 requestBody: required: false content: @@ -44637,9 +46364,9 @@ paths: description: Response content: application/json: - schema: *339 + schema: *357 examples: - response-if-user-already-had-membership-with-organization: *340 + response-if-user-already-had-membership-with-organization: *358 '422': *15 '403': *27 x-github: @@ -44663,8 +46390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -44689,7 +46416,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *76 + - *81 - *17 - *19 - name: exclude @@ -44711,7 +46438,7 @@ paths: application/json: schema: type: array - items: &341 + items: &359 title: Migration description: A migration. type: object @@ -44753,7 +46480,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *67 + items: *72 url: type: string format: uri @@ -44968,7 +46695,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *76 + - *81 requestBody: required: true content: @@ -45049,7 +46776,7 @@ paths: description: Response content: application/json: - schema: *341 + schema: *359 examples: default: value: @@ -45227,8 +46954,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *76 - - &342 + - *81 + - &360 name: migration_id description: The unique identifier of the migration. in: path @@ -45256,7 +46983,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *341 + schema: *359 examples: default: value: @@ -45425,8 +47152,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *76 - - *342 + - *81 + - *360 responses: '302': description: Response @@ -45447,8 +47174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *76 - - *342 + - *81 + - *360 responses: '204': description: Response @@ -45471,9 +47198,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *76 - - *342 - - &780 + - *81 + - *360 + - &799 name: repo_name description: repo_name parameter in: path @@ -45500,8 +47227,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *76 - - *342 + - *81 + - *360 - *17 - *19 responses: @@ -45511,9 +47238,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: &352 + default: &370 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -45652,7 +47379,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: - - *76 + - *81 responses: '200': description: Response @@ -45706,7 +47433,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: - - *76 + - *81 responses: '200': description: Response - list of organization roles @@ -45722,7 +47449,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &343 + items: &361 title: Organization Role description: Organization roles type: object @@ -45884,7 +47611,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *76 + - *81 requestBody: required: true content: @@ -45931,7 +47658,7 @@ paths: description: Response content: application/json: - schema: *343 + schema: *361 examples: default: value: @@ -45960,7 +47687,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -45982,8 +47709,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: - - *76 - - *180 + - *81 + - *197 responses: '204': description: Response @@ -46008,9 +47735,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: - - *76 - - *180 - - *291 + - *81 + - *197 + - *311 responses: '204': description: Response @@ -46039,9 +47766,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: - - *76 - - *180 - - *291 + - *81 + - *197 + - *311 responses: '204': description: Response @@ -46066,8 +47793,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -46092,9 +47819,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: - - *76 - - *178 - - *291 + - *81 + - *194 + - *311 responses: '204': description: Response @@ -46124,9 +47851,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: - - *76 - - *178 - - *291 + - *81 + - *194 + - *311 responses: '204': description: Response @@ -46154,14 +47881,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *76 - - *291 + - *81 + - *311 responses: '200': description: Response content: application/json: - schema: *343 + schema: *361 examples: default: value: @@ -46218,8 +47945,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *76 - - *291 + - *81 + - *311 requestBody: required: true content: @@ -46258,7 +47985,7 @@ paths: description: Response content: application/json: - schema: *343 + schema: *361 examples: default: value: @@ -46286,7 +48013,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *107 + '409': *112 '404': *6 x-github: githubCloudOnly: true @@ -46311,8 +48038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *76 - - *291 + - *81 + - *311 responses: '204': description: Response @@ -46337,8 +48064,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: - - *76 - - *291 + - *81 + - *311 - *17 - *19 responses: @@ -46417,7 +48144,7 @@ paths: parent: anyOf: - type: 'null' - - *344 + - *362 type: description: The ownership type of the team type: string @@ -46450,7 +48177,7 @@ paths: - type - parent examples: - default: *345 + default: *363 headers: Link: *41 '404': @@ -46479,8 +48206,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: - - *76 - - *291 + - *81 + - *311 - *17 - *19 responses: @@ -46509,7 +48236,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *344 + items: *362 name: type: - string @@ -46626,7 +48353,7 @@ paths: - type - url examples: - default: *177 + default: *193 headers: Link: *41 '404': @@ -46650,7 +48377,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: - - *76 + - *81 - 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) @@ -46677,7 +48404,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -46702,8 +48429,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: - - *76 - - *178 + - *81 + - *194 requestBody: required: false content: @@ -46760,8 +48487,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -46818,8 +48545,8 @@ paths: - docker - nuget - container - - *76 - - &782 + - *81 + - &800 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -46855,12 +48582,12 @@ paths: application/json: schema: type: array - items: *346 + items: *364 examples: - default: *347 + default: *365 '403': *27 '401': *23 - '400': &784 + '400': &802 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -46882,7 +48609,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &348 + - &366 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 @@ -46900,20 +48627,20 @@ paths: - docker - nuget - container - - &349 + - &367 name: package_name description: The name of the package. in: path required: true schema: type: string - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *346 + schema: *364 examples: default: value: @@ -46965,9 +48692,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *348 - - *349 - - *76 + - *366 + - *367 + - *81 responses: '204': description: Response @@ -46999,9 +48726,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *348 - - *349 - - *76 + - *366 + - *367 + - *81 - name: token description: package token schema: @@ -47033,9 +48760,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: - - *348 - - *349 - - *76 + - *366 + - *367 + - *81 - *19 - *17 - name: state @@ -47055,7 +48782,7 @@ paths: application/json: schema: type: array - items: &350 + items: &368 title: Package Version description: A version of a software package type: object @@ -47190,10 +48917,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: - - *348 - - *349 - - *76 - - &351 + - *366 + - *367 + - *81 + - &369 name: package_version_id description: Unique identifier of the package version. in: path @@ -47205,7 +48932,7 @@ paths: description: Response content: application/json: - schema: *350 + schema: *368 examples: default: value: @@ -47241,10 +48968,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *348 - - *349 - - *76 - - *351 + - *366 + - *367 + - *81 + - *369 responses: '204': description: Response @@ -47276,10 +49003,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *348 - - *349 - - *76 - - *351 + - *366 + - *367 + - *81 + - *369 responses: '204': description: Response @@ -47306,10 +49033,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: - - *76 + - *81 - *17 - *19 - - &353 + - &371 name: sort description: The property by which to sort the results. in: query @@ -47319,8 +49046,8 @@ paths: enum: - created_at default: created_at - - *99 - - &354 + - *104 + - &372 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -47332,7 +49059,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &355 + - &373 name: repository description: The name of the repository to use to filter the results. in: query @@ -47341,7 +49068,7 @@ paths: type: string examples: - Hello-World - - &356 + - &374 name: permission description: The permission to use to filter the results. in: query @@ -47350,7 +49077,7 @@ paths: type: string examples: - issues_read - - &357 + - &375 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) @@ -47360,7 +49087,7 @@ paths: schema: type: string format: date-time - - &358 + - &376 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) @@ -47370,7 +49097,7 @@ paths: schema: type: string format: date-time - - &359 + - &377 name: token_id description: The ID of the token in: query @@ -47538,7 +49265,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: - - *76 + - *81 requestBody: required: true content: @@ -47605,7 +49332,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: - - *76 + - *81 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -47646,7 +49373,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *129 + '204': *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47667,7 +49394,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: - - *76 + - *81 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -47687,9 +49414,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -47712,17 +49439,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: - - *76 + - *81 - *17 - *19 - - *353 - - *99 - - *354 - - *355 - - *356 - - *357 - - *358 - - *359 + - *371 + - *104 + - *372 + - *373 + - *374 + - *375 + - *376 + - *377 responses: '500': *38 '422': *15 @@ -47873,7 +49600,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: - - *76 + - *81 requestBody: required: true content: @@ -47933,7 +49660,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: - - *76 + - *81 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -47963,7 +49690,7 @@ paths: responses: '500': *38 '404': *6 - '204': *129 + '204': *139 '403': *27 '422': *15 x-github: @@ -47985,7 +49712,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: - - *76 + - *81 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -48004,9 +49731,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -48030,7 +49757,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: - - *76 + - *81 - *17 - *19 responses: @@ -48048,7 +49775,7 @@ paths: type: integer configurations: type: array - items: &360 + items: &378 title: Organization private registry description: Private registry configuration for an organization type: object @@ -48139,7 +49866,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: - - *76 + - *81 requestBody: required: true content: @@ -48307,7 +50034,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &361 + org-private-registry-with-selected-visibility: &379 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -48348,7 +50075,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: - - *76 + - *81 responses: '200': description: Response @@ -48398,16 +50125,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: - - *76 - - *256 + - *81 + - *276 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *360 + schema: *378 examples: - default: *361 + default: *379 '404': *6 x-github: githubCloudOnly: false @@ -48428,8 +50155,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: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -48525,8 +50252,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: - - *76 - - *256 + - *81 + - *276 responses: '204': description: Response @@ -48551,7 +50278,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects parameters: - - *76 + - *81 - name: state description: Indicates the state of the projects to return. in: query @@ -48572,7 +50299,7 @@ paths: application/json: schema: type: array - items: &362 + items: &380 title: Project description: Projects are a way to organize columns and cards of work. @@ -48728,7 +50455,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project parameters: - - *76 + - *81 requestBody: required: true content: @@ -48754,7 +50481,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *380 examples: default: value: @@ -48792,7 +50519,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &441 + '410': &458 description: Gone content: application/json: @@ -48818,15 +50545,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization parameters: - - *76 + - *81 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *97 - - *98 + - *102 + - *103 - *17 responses: '200': @@ -48835,7 +50562,7 @@ paths: application/json: schema: type: array - items: &363 + items: &381 title: Projects v2 Project description: A projects v2 project type: object @@ -48909,7 +50636,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &857 + - &875 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -48994,7 +50721,7 @@ paths: - deleted_at - deleted_by examples: - default: &364 + default: &382 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -49097,22 +50824,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &365 + - &383 name: project_number description: The project's number. in: path required: true schema: type: integer - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *363 + schema: *381 examples: - default: *364 + default: *382 headers: Link: *41 '304': *35 @@ -49134,11 +50861,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *365 - - *76 + - *383 + - *81 - *17 - - *97 - - *98 + - *102 + - *103 responses: '200': description: Response @@ -49146,7 +50873,7 @@ paths: application/json: schema: type: array - items: &366 + items: &384 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -49296,7 +51023,7 @@ paths: - updated_at - project_url examples: - default: &367 + default: &385 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -49339,23 +51066,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *365 - - &801 + - *383 + - &819 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *366 + schema: *384 examples: - default: *367 + default: *385 headers: Link: *41 '304': *35 @@ -49378,8 +51105,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: - - *365 - - *76 + - *383 + - *81 - 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. @@ -49388,19 +51115,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 - - *97 - - *98 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - *102 + - *103 - *17 responses: '200': @@ -49409,7 +51138,7 @@ paths: application/json: schema: type: array - items: &372 + items: &390 title: Projects v2 Item description: An item belonging to a project type: object @@ -49426,7 +51155,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: &370 + content_type: &388 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -49483,7 +51212,7 @@ paths: - updated_at - archived_at examples: - default: &373 + default: &391 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -50177,8 +51906,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - - *76 - - *365 + - *81 + - *383 requestBody: required: true description: Details of the item to add to the project. @@ -50215,7 +51944,7 @@ paths: description: Response content: application/json: - schema: &802 + schema: &820 title: Projects v2 Item description: An item belonging to a project type: object @@ -50228,8 +51957,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *183 - - &549 + - *200 + - &566 title: Pull Request Simple description: Pull Request Simple type: object @@ -50349,7 +52078,7 @@ paths: milestone: anyOf: - type: 'null' - - *368 + - *386 active_lock_reason: type: - string @@ -50404,7 +52133,7 @@ paths: type: - array - 'null' - items: *273 + items: *293 head: type: object properties: @@ -50412,7 +52141,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *72 sha: type: string user: @@ -50432,7 +52161,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *72 sha: type: string user: @@ -50448,7 +52177,7 @@ paths: _links: type: object properties: - comments: &369 + comments: &387 title: Link description: Hypermedia Link type: object @@ -50457,13 +52186,13 @@ paths: type: string required: - href - commits: *369 - statuses: *369 - html: *369 - issue: *369 - review_comments: *369 - review_comment: *369 - self: *369 + commits: *387 + statuses: *387 + html: *387 + issue: *387 + review_comments: *387 + review_comment: *387 + self: *387 required: - comments - commits @@ -50473,8 +52202,8 @@ paths: - review_comments - review_comment - self - author_association: *184 - auto_merge: &655 + author_association: *201 + auto_merge: &674 title: Auto merge description: The status of auto merging a pull request. type: @@ -50576,7 +52305,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *370 + content_type: *388 creator: *4 created_at: type: string @@ -50613,7 +52342,7 @@ paths: - updated_at - archived_at examples: - issue: &371 + issue: &389 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -50668,7 +52397,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: *371 + pull_request: *389 '304': *35 '403': *27 '401': *23 @@ -50688,9 +52417,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: - - *365 - - *76 - - &374 + - *383 + - *81 + - &392 name: item_id description: The unique identifier of the project item. in: path @@ -50698,25 +52427,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *372 + schema: *390 examples: - default: *373 + default: *391 headers: Link: *41 '304': *35 @@ -50737,9 +52468,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *365 - - *76 - - *374 + - *383 + - *81 + - *392 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -50812,13 +52543,13 @@ paths: description: Response content: application/json: - schema: *372 + schema: *390 examples: - text_field: *373 - number_field: *373 - date_field: *373 - single_select_field: *373 - iteration_field: *373 + text_field: *391 + number_field: *391 + date_field: *391 + single_select_field: *391 + iteration_field: *391 '401': *23 '403': *27 '404': *6 @@ -50838,9 +52569,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *365 - - *76 - - *374 + - *383 + - *81 + - *392 responses: '204': description: Response @@ -50864,7 +52595,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: - - *76 + - *81 responses: '200': description: Response @@ -50872,9 +52603,9 @@ paths: application/json: schema: type: array - items: *125 + items: *141 examples: - default: *126 + default: *142 '403': *27 '404': *6 x-github: @@ -50901,7 +52632,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: - - *76 + - *81 requestBody: required: true content: @@ -50912,7 +52643,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *125 + items: *141 minItems: 1 maxItems: 100 required: @@ -50942,9 +52673,9 @@ paths: application/json: schema: type: array - items: *125 + items: *141 examples: - default: *126 + default: *142 '403': *27 '404': *6 x-github: @@ -50965,16 +52696,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: - - *76 - - *127 + - *81 + - *137 responses: '200': description: Response content: application/json: - schema: *125 + schema: *141 examples: - default: *128 + default: *143 '403': *27 '404': *6 x-github: @@ -50997,13 +52728,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: - - *76 - - *127 + - *81 + - *137 requestBody: required: true content: application/json: - schema: *375 + schema: *393 examples: default: value: @@ -51019,9 +52750,9 @@ paths: description: Response content: application/json: - schema: *125 + schema: *141 examples: - default: *128 + default: *143 '403': *27 '404': *6 x-github: @@ -51044,10 +52775,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: - - *76 - - *127 + - *81 + - *137 responses: - '204': *129 + '204': *139 '403': *27 '404': *6 x-github: @@ -51068,7 +52799,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: - - *76 + - *81 - *17 - *19 - name: repository_query @@ -51109,28 +52840,7 @@ paths: - octocat/Hello-World properties: type: array - items: &376 - 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 - type: - - 'null' - - string - - array - required: - - property_name - - value + items: *140 description: List of custom property names and associated values required: - repository_id @@ -51179,7 +52889,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: - - *76 + - *81 requestBody: required: true content: @@ -51199,7 +52909,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *376 + items: *140 required: - repository_names - properties @@ -51240,7 +52950,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *76 + - *81 - *17 - *19 responses: @@ -51252,7 +52962,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -51271,8 +52981,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response if user is a public member @@ -51296,8 +53006,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -51318,8 +53028,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -51343,7 +53053,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *76 + - *81 - 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 @@ -51390,9 +53100,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -51413,7 +53123,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *76 + - *81 requestBody: required: true content: @@ -51596,7 +53306,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &460 title: Full Repository description: Full Repository type: object @@ -51942,7 +53652,7 @@ paths: template_repository: anyOf: - type: 'null' - - *67 + - *72 temp_clone_token: type: - string @@ -52042,13 +53752,13 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 organization: anyOf: - type: 'null' - *4 - parent: *67 - source: *67 + parent: *72 + source: *72 forks: type: integer master_branch: @@ -52061,7 +53771,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &554 + code_of_conduct: &571 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -52091,7 +53801,7 @@ paths: - key - name - html_url - security_and_analysis: *377 + security_and_analysis: *394 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -52175,7 +53885,7 @@ paths: - network_count - subscribers_count examples: - default: &445 + default: &462 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -52693,7 +54403,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: - - *76 + - *81 responses: '200': description: Response @@ -52701,9 +54411,9 @@ paths: application/json: schema: type: array - items: *378 + items: *395 examples: - default: *379 + default: *396 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -52725,10 +54435,10 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *81 - *17 - *19 - - &678 + - &697 name: targets description: | A comma-separated list of rule targets to filter by. @@ -52747,7 +54457,7 @@ paths: application/json: schema: type: array - items: *158 + items: *174 examples: default: value: @@ -52794,7 +54504,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *81 requestBody: description: Request body required: true @@ -52815,40 +54525,40 @@ paths: - push - repository default: branch - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 - conditions: *380 + items: *153 + conditions: *397 rules: type: array description: An array of rules within the ruleset. - items: &382 + items: &399 title: Repository Rule type: object description: A repository rule. oneOf: - - *138 - - *139 - - *140 - - *141 - - *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 required: - name - enforcement @@ -52886,9 +54596,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: &381 + default: &398 value: id: 21 name: super cool ruleset @@ -52942,8 +54652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *76 - - &680 + - *81 + - &699 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 @@ -52953,16 +54663,16 @@ paths: schema: type: string x-multi-segment: true - - *270 - - *94 - - &681 + - *290 + - *99 + - &700 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 - - &682 + - &701 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -52982,7 +54692,7 @@ paths: description: Response content: application/json: - schema: &683 + schema: &702 title: Rule Suites description: Response type: array @@ -53038,7 +54748,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &684 + default: &703 value: - id: 21 actor_id: 12 @@ -53081,8 +54791,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *76 - - &685 + - *81 + - &704 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -53098,7 +54808,7 @@ paths: description: Response content: application/json: - schema: &686 + schema: &705 title: Rule Suite description: Response type: object @@ -53205,7 +54915,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &687 + default: &706 value: id: 21 actor_id: 12 @@ -53266,7 +54976,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *81 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53278,9 +54988,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *381 + default: *398 '404': *6 '500': *38 put: @@ -53298,7 +55008,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *81 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53324,16 +55034,16 @@ paths: - tag - push - repository - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 - conditions: *380 + items: *153 + conditions: *397 rules: description: An array of rules within the ruleset. type: array - items: *382 + items: *399 examples: default: value: @@ -53368,9 +55078,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *381 + default: *398 '404': *6 '500': *38 delete: @@ -53388,7 +55098,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *81 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53411,7 +55121,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history parameters: - - *76 + - *81 - *17 - *19 - name: ruleset_id @@ -53427,9 +55137,9 @@ paths: application/json: schema: type: array - items: *162 + items: *178 examples: - default: *383 + default: *400 '404': *6 '500': *38 x-github: @@ -53448,7 +55158,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version parameters: - - *76 + - *81 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53466,7 +55176,7 @@ paths: description: Response content: application/json: - schema: *384 + schema: *401 examples: default: value: @@ -53528,15 +55238,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: - - *76 - - *385 - - *386 - - *387 - - *388 - - *99 + - *81 + - *402 + - *403 + - *404 + - *405 + - *104 - *19 - *17 - - &689 + - &708 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 @@ -53546,7 +55256,7 @@ paths: required: false schema: type: string - - &690 + - &709 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 @@ -53556,10 +55266,10 @@ paths: required: false schema: type: string - - *389 - - *390 - - *391 - - *392 + - *406 + - *407 + - *408 + - *409 responses: '200': description: Response @@ -53567,13 +55277,13 @@ paths: application/json: schema: type: array - items: *393 + items: *410 examples: - default: *394 + default: *411 headers: Link: *41 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53598,15 +55308,15 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *395 + schema: *412 examples: - default: *396 + default: *413 '403': *27 '404': *6 patch: @@ -53627,7 +55337,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *76 + - *81 requestBody: required: true content: @@ -53635,7 +55345,7 @@ paths: schema: type: object properties: - pattern_config_version: *165 + pattern_config_version: *181 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -53661,7 +55371,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *165 + custom_pattern_version: *181 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -53697,7 +55407,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 "/orgs/{org}/security-advisories": get: @@ -53715,8 +55425,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: - - *76 - - *99 + - *81 + - *104 - name: sort description: The property to sort the results by. in: query @@ -53728,8 +55438,8 @@ paths: - updated - published default: created - - *97 - - *98 + - *102 + - *103 - 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)." @@ -53759,7 +55469,7 @@ paths: application/json: schema: type: array - items: &711 + items: &730 description: A repository security advisory. type: object properties: @@ -53967,7 +55677,7 @@ paths: required: - vector_string - score - cvss_severities: *111 + cvss_severities: *121 cwes: type: - array @@ -54003,7 +55713,7 @@ paths: login: type: string description: The username of the user credited. - type: *397 + type: *414 credits_detailed: type: - array @@ -54014,7 +55724,7 @@ paths: type: object properties: user: *4 - type: *397 + type: *414 state: type: string description: The state of the user's acceptance of the @@ -54040,13 +55750,13 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *273 + items: *293 private_fork: readOnly: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *108 + - *113 type: - 'null' required: @@ -54078,7 +55788,7 @@ paths: - private_fork additionalProperties: false examples: - default: &712 + default: &731 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -54457,7 +56167,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *76 + - *81 responses: '200': description: Response @@ -54465,9 +56175,9 @@ paths: application/json: schema: type: array - items: *344 + items: *362 examples: - default: *345 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54490,8 +56200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *76 - - *180 + - *81 + - *197 responses: '204': description: Response @@ -54516,8 +56226,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *76 - - *180 + - *81 + - *197 responses: '204': description: Response @@ -54546,15 +56256,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *398 + schema: *415 examples: - default: *399 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54578,8 +56288,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: - - *76 - - *400 + - *81 + - *417 - *17 - *19 responses: @@ -54587,9 +56297,9 @@ paths: description: Success content: application/json: - schema: *401 + schema: *418 examples: - default: *402 + default: *419 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -54611,15 +56321,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *403 + schema: *420 examples: - default: *404 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54641,15 +56351,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *405 + schema: *422 examples: - default: *406 + default: *423 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54669,7 +56379,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: - - *76 + - *81 responses: '200': description: Immutable releases settings response @@ -54719,7 +56429,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: - - *76 + - *81 responses: '204': description: Response @@ -54777,7 +56487,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: - - *76 + - *81 - *19 - *17 responses: @@ -54795,9 +56505,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: *260 + default: *280 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54816,7 +56526,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: - - *76 + - *81 requestBody: required: true content: @@ -54865,8 +56575,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: - - *76 - - *240 + - *81 + - *260 responses: '204': description: Response @@ -54888,8 +56598,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: - - *76 - - *240 + - *81 + - *260 responses: '204': description: Response @@ -54912,7 +56622,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: - - *76 + - *81 - *17 - *19 responses: @@ -54930,9 +56640,9 @@ paths: type: integer network_configurations: type: array - items: *122 + items: *132 examples: - default: *407 + default: *424 headers: Link: *41 x-github: @@ -54953,7 +56663,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: - - *76 + - *81 requestBody: required: true content: @@ -54995,9 +56705,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: *123 + default: *133 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55017,16 +56727,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: - - *76 - - *124 + - *81 + - *134 responses: '200': description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: *123 + default: *133 headers: Link: *41 x-github: @@ -55047,8 +56757,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: - - *76 - - *124 + - *81 + - *134 requestBody: required: true content: @@ -55087,9 +56797,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: *123 + default: *133 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55108,8 +56818,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: - - *76 - - *124 + - *81 + - *134 responses: '204': description: Response @@ -55132,16 +56842,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: - - *76 - - *408 + - *81 + - *425 responses: '200': description: Response content: application/json: - schema: *409 + schema: *426 examples: - default: *410 + default: *427 headers: Link: *41 x-github: @@ -55160,7 +56870,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: - - *76 + - *81 - *17 - name: page description: Page token @@ -55179,7 +56889,7 @@ paths: description: Response content: application/json: - schema: &432 + schema: &449 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -55231,7 +56941,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &433 + default: &450 value: groups: - group_id: '123' @@ -55276,8 +56986,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: - - *76 - - *180 + - *81 + - *197 - 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`). @@ -55309,13 +57019,13 @@ paths: application/json: schema: type: array - items: *171 + items: *187 examples: - default: *172 + default: *188 '500': *38 '403': *27 '404': *6 - '422': *173 + '422': *189 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55333,7 +57043,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *76 + - *81 - *17 - *19 responses: @@ -55343,9 +57053,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 headers: Link: *41 '403': *27 @@ -55367,7 +57077,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *76 + - *81 requestBody: required: true content: @@ -55439,7 +57149,7 @@ paths: description: Response content: application/json: - schema: &411 + schema: &428 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -55513,7 +57223,7 @@ paths: parent: anyOf: - type: 'null' - - *344 + - *362 members_count: type: integer examples: @@ -55838,7 +57548,7 @@ paths: - repos_count - organization examples: - default: &412 + default: &429 value: id: 1 node_id: MDQ6VGVhbTE= @@ -55908,16 +57618,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *76 - - *180 + - *81 + - *197 responses: '200': description: Response content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '404': *6 x-github: githubCloudOnly: false @@ -55938,8 +57648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *76 - - *180 + - *81 + - *197 requestBody: required: false content: @@ -56002,16 +57712,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '201': description: Response content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '404': *6 '422': *15 '403': *27 @@ -56036,8 +57746,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *76 - - *180 + - *81 + - *197 responses: '204': description: Response @@ -56063,9 +57773,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *76 - - *180 - - *99 + - *81 + - *197 + - *104 - *17 - *19 - name: pinned @@ -56081,7 +57791,7 @@ paths: application/json: schema: type: array - items: &413 + items: &430 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -56172,7 +57882,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *185 + reactions: *202 required: - author - body @@ -56192,7 +57902,7 @@ paths: - updated_at - url examples: - default: &755 + default: &774 value: - author: login: octocat @@ -56266,8 +57976,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *76 - - *180 + - *81 + - *197 requestBody: required: true content: @@ -56301,9 +58011,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: &414 + default: &431 value: author: login: octocat @@ -56375,9 +58085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *76 - - *180 - - &415 + - *81 + - *197 + - &432 name: discussion_number description: The number that identifies the discussion. in: path @@ -56389,9 +58099,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: *414 + default: *431 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56413,9 +58123,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *76 - - *180 - - *415 + - *81 + - *197 + - *432 requestBody: required: false content: @@ -56438,9 +58148,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: &756 + default: &775 value: author: login: octocat @@ -56510,9 +58220,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *76 - - *180 - - *415 + - *81 + - *197 + - *432 responses: '204': description: Response @@ -56538,10 +58248,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *76 - - *180 - - *415 - - *99 + - *81 + - *197 + - *432 + - *104 - *17 - *19 responses: @@ -56551,7 +58261,7 @@ paths: application/json: schema: type: array - items: &416 + items: &433 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -56616,7 +58326,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *185 + reactions: *202 required: - author - body @@ -56631,7 +58341,7 @@ paths: - updated_at - url examples: - default: &757 + default: &776 value: - author: login: octocat @@ -56699,9 +58409,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *76 - - *180 - - *415 + - *81 + - *197 + - *432 requestBody: required: true content: @@ -56723,9 +58433,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: &417 + default: &434 value: author: login: octocat @@ -56791,10 +58501,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *76 - - *180 - - *415 - - &418 + - *81 + - *197 + - *432 + - &435 name: comment_number description: The number that identifies the comment. in: path @@ -56806,9 +58516,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: *417 + default: *434 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56830,10 +58540,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *76 - - *180 - - *415 - - *418 + - *81 + - *197 + - *432 + - *435 requestBody: required: true content: @@ -56855,9 +58565,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: &758 + default: &777 value: author: login: octocat @@ -56921,10 +58631,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *76 - - *180 - - *415 - - *418 + - *81 + - *197 + - *432 + - *435 responses: '204': description: Response @@ -56950,10 +58660,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: - - *76 - - *180 - - *415 - - *418 + - *81 + - *197 + - *432 + - *435 - 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. @@ -56979,7 +58689,7 @@ paths: application/json: schema: type: array - items: &419 + items: &436 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -57023,7 +58733,7 @@ paths: - content - created_at examples: - default: &421 + default: &438 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57073,10 +58783,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: - - *76 - - *180 - - *415 - - *418 + - *81 + - *197 + - *432 + - *435 requestBody: required: true content: @@ -57109,9 +58819,9 @@ paths: team discussion comment content: application/json: - schema: *419 + schema: *436 examples: - default: &420 + default: &437 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57140,9 +58850,9 @@ paths: description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57165,11 +58875,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *76 - - *180 - - *415 - - *418 - - &422 + - *81 + - *197 + - *432 + - *435 + - &439 name: reaction_id description: The unique identifier of the reaction. in: path @@ -57201,9 +58911,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *76 - - *180 - - *415 + - *81 + - *197 + - *432 - 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. @@ -57229,9 +58939,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 x-github: @@ -57257,9 +58967,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *76 - - *180 - - *415 + - *81 + - *197 + - *432 requestBody: required: true content: @@ -57291,16 +59001,16 @@ paths: description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57323,10 +59033,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *76 - - *180 - - *415 - - *422 + - *81 + - *197 + - *432 + - *439 responses: '204': description: Response @@ -57349,16 +59059,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: - - *76 - - *180 + - *81 + - *197 responses: '200': description: Response content: application/json: - schema: *423 + schema: *440 examples: - default: *424 + default: *441 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57377,8 +59087,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: - - *76 - - *180 + - *81 + - *197 requestBody: required: true content: @@ -57402,9 +59112,9 @@ paths: description: Response content: application/json: - schema: *425 + schema: *442 examples: - default: *426 + default: *443 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57423,8 +59133,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: - - *76 - - *180 + - *81 + - *197 responses: '204': description: Response @@ -57448,8 +59158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *76 - - *180 + - *81 + - *197 - *17 - *19 responses: @@ -57459,9 +59169,9 @@ paths: application/json: schema: type: array - items: *328 + items: *346 examples: - default: *329 + default: *347 headers: Link: *41 x-github: @@ -57483,8 +59193,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *76 - - *180 + - *81 + - *197 - name: role description: Filters members returned by their role in the team. in: query @@ -57507,7 +59217,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -57537,15 +59247,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *76 - - *180 - - *178 + - *81 + - *197 + - *194 responses: '200': description: Response content: application/json: - schema: &427 + schema: &444 title: Team Membership description: Team Membership type: object @@ -57573,7 +59283,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &759 + response-if-user-is-a-team-maintainer: &778 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57609,9 +59319,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: - - *76 - - *180 - - *178 + - *81 + - *197 + - *194 requestBody: required: false content: @@ -57636,9 +59346,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *444 examples: - response-if-users-membership-with-team-is-now-pending: &760 + response-if-users-membership-with-team-is-now-pending: &779 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -57673,9 +59383,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *76 - - *180 - - *178 + - *81 + - *197 + - *194 responses: '204': description: Response @@ -57700,8 +59410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *76 - - *180 + - *81 + - *197 - *17 - *19 responses: @@ -57711,7 +59421,7 @@ paths: application/json: schema: type: array - items: &428 + items: &445 title: Team Project description: A team's access to a project. type: object @@ -57780,7 +59490,7 @@ paths: - updated_at - permissions examples: - default: &761 + default: &780 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -57843,9 +59553,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *76 - - *180 - - &429 + - *81 + - *197 + - &446 name: project_id description: The unique identifier of the project. in: path @@ -57857,9 +59567,9 @@ paths: description: Response content: application/json: - schema: *428 + schema: *445 examples: - default: &762 + default: &781 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -57921,9 +59631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *76 - - *180 - - *429 + - *81 + - *197 + - *446 requestBody: required: false content: @@ -57990,9 +59700,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *76 - - *180 - - *429 + - *81 + - *197 + - *446 responses: '204': description: Response @@ -58019,8 +59729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *76 - - *180 + - *81 + - *197 - *17 - *19 responses: @@ -58030,9 +59740,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -58061,16 +59771,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *76 - - *180 - - *430 - - *431 + - *81 + - *197 + - *447 + - *448 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &763 + schema: &782 title: Team Repository description: A team's access to a repository. type: object @@ -58096,7 +59806,7 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 forks: type: integer permissions: @@ -58711,10 +60421,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *76 - - *180 - - *430 - - *431 + - *81 + - *197 + - *447 + - *448 requestBody: required: false content: @@ -58759,10 +60469,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *76 - - *180 - - *430 - - *431 + - *81 + - *197 + - *447 + - *448 responses: '204': description: Response @@ -58788,16 +60498,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: - - *76 - - *180 + - *81 + - *197 responses: '200': description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *433 + default: *450 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -58819,8 +60529,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: - - *76 - - *180 + - *81 + - *197 requestBody: required: true content: @@ -58863,7 +60573,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: default: value: @@ -58895,8 +60605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *76 - - *180 + - *81 + - *197 - *17 - *19 responses: @@ -58906,9 +60616,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - response-if-child-teams-exist: &764 + response-if-child-teams-exist: &783 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -58961,7 +60671,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: - - *76 + - *81 - name: security_product in: path description: The security feature to enable or disable. @@ -59035,7 +60745,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &434 + - &451 name: card_id description: The unique identifier of the card. in: path @@ -59047,7 +60757,7 @@ paths: description: Response content: application/json: - schema: &435 + schema: &452 title: Project Card description: Project cards represent a scope of work. type: object @@ -59122,7 +60832,7 @@ paths: - created_at - updated_at examples: - default: &436 + default: &453 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -59178,7 +60888,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *434 + - *451 requestBody: required: false content: @@ -59208,9 +60918,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '304': *35 '403': *27 '401': *23 @@ -59237,7 +60947,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *434 + - *451 responses: '204': description: Response @@ -59281,7 +60991,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *434 + - *451 requestBody: required: true content: @@ -59394,7 +61104,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &437 + - &454 name: column_id description: The unique identifier of the column. in: path @@ -59406,7 +61116,7 @@ paths: description: Response content: application/json: - schema: &438 + schema: &455 title: Project Column description: Project columns contain cards of work. type: object @@ -59460,7 +61170,7 @@ paths: - created_at - updated_at examples: - default: &439 + default: &456 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -59495,7 +61205,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *437 + - *454 requestBody: required: true content: @@ -59520,9 +61230,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *455 examples: - default: *439 + default: *456 '304': *35 '403': *27 '401': *23 @@ -59547,7 +61257,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *437 + - *454 responses: '204': description: Response @@ -59576,7 +61286,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *437 + - *454 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -59597,7 +61307,7 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: default: value: @@ -59656,7 +61366,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *437 + - *454 requestBody: required: true content: @@ -59700,9 +61410,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '304': *35 '403': *27 '401': *23 @@ -59712,8 +61422,8 @@ paths: application/json: schema: oneOf: - - *223 - - *224 + - *241 + - *242 '503': description: Response content: @@ -59758,7 +61468,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *437 + - *454 requestBody: required: true content: @@ -59819,15 +61529,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project parameters: - - *429 + - *446 responses: '200': description: Response content: application/json: - schema: *362 + schema: *380 examples: - default: &440 + default: &457 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -59884,7 +61594,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project parameters: - - *429 + - *446 requestBody: required: false content: @@ -59933,9 +61643,9 @@ paths: description: Response content: application/json: - schema: *362 + schema: *380 examples: - default: *440 + default: *457 '404': description: Not Found if the authenticated user does not have access to the project @@ -59956,7 +61666,7 @@ paths: items: type: string '401': *23 - '410': *441 + '410': *458 '422': *7 x-github: githubCloudOnly: false @@ -59979,7 +61689,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project parameters: - - *429 + - *446 responses: '204': description: Delete Success @@ -60000,7 +61710,7 @@ paths: items: type: string '401': *23 - '410': *441 + '410': *458 '404': *6 x-github: githubCloudOnly: false @@ -60024,7 +61734,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *429 + - *446 - 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 @@ -60051,7 +61761,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '404': *6 @@ -60081,8 +61791,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *429 - - *178 + - *446 + - *194 requestBody: required: false content: @@ -60136,8 +61846,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *429 - - *178 + - *446 + - *194 responses: '204': description: Response @@ -60168,8 +61878,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: - - *429 - - *178 + - *446 + - *194 responses: '200': description: Response @@ -60239,7 +61949,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#list-project-columns parameters: - - *429 + - *446 - *17 - *19 responses: @@ -60249,7 +61959,7 @@ paths: application/json: schema: type: array - items: *438 + items: *455 examples: default: value: @@ -60287,7 +61997,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#create-a-project-column parameters: - - *429 + - *446 requestBody: required: true content: @@ -60311,7 +62021,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *455 examples: default: value: @@ -60376,7 +62086,7 @@ paths: resources: type: object properties: - core: &442 + core: &459 title: Rate Limit type: object properties: @@ -60393,21 +62103,21 @@ paths: - remaining - reset - used - graphql: *442 - search: *442 - code_search: *442 - source_import: *442 - integration_manifest: *442 - code_scanning_upload: *442 - actions_runner_registration: *442 - scim: *442 - dependency_snapshots: *442 - dependency_sbom: *442 - code_scanning_autofix: *442 + graphql: *459 + search: *459 + code_search: *459 + source_import: *459 + integration_manifest: *459 + code_scanning_upload: *459 + actions_runner_registration: *459 + scim: *459 + dependency_snapshots: *459 + dependency_sbom: *459 + code_scanning_autofix: *459 required: - core - search - rate: *442 + rate: *459 required: - rate - resources @@ -60512,14 +62222,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *443 + schema: *460 examples: default-response: summary: Default response @@ -61024,7 +62734,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *444 + '301': *461 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61042,8 +62752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -61301,10 +63011,10 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - default: *445 - '307': &446 + default: *462 + '307': &463 description: Temporary Redirect content: application/json: @@ -61333,8 +63043,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -61356,9 +63066,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': *446 + '307': *463 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61380,11 +63090,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 - - &461 + - &478 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -61407,7 +63117,7 @@ paths: type: integer artifacts: type: array - items: &447 + items: &464 title: Artifact description: An artifact type: object @@ -61502,7 +63212,7 @@ paths: - expires_at - updated_at examples: - default: &462 + default: &479 value: total_count: 2 artifacts: @@ -61563,9 +63273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *430 - - *431 - - &448 + - *447 + - *448 + - &465 name: artifact_id description: The unique identifier of the artifact. in: path @@ -61577,7 +63287,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *464 examples: default: value: @@ -61615,9 +63325,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *430 - - *431 + - *447 - *448 + - *465 responses: '204': description: Response @@ -61641,9 +63351,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *430 - - *431 + - *447 - *448 + - *465 - name: archive_format in: path required: true @@ -61657,7 +63367,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': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61680,14 +63390,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *449 + schema: *466 examples: default: value: @@ -61713,11 +63423,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: - - *430 - - *431 + - *447 + - *448 - *17 - *19 - - &450 + - &467 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 @@ -61745,13 +63455,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *99 + - *104 responses: '200': description: Response content: application/json: - schema: &451 + schema: &468 title: Repository actions caches description: Repository actions caches type: object @@ -61801,7 +63511,7 @@ paths: - total_count - actions_caches examples: - default: &452 + default: &469 value: total_count: 1 actions_caches: @@ -61833,23 +63543,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: - - *430 - - *431 + - *447 + - *448 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *450 + - *467 responses: '200': description: Response content: application/json: - schema: *451 + schema: *468 examples: - default: *452 + default: *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61869,8 +63579,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: - - *430 - - *431 + - *447 + - *448 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -61901,9 +63611,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: - - *430 - - *431 - - &453 + - *447 + - *448 + - &470 name: job_id description: The unique identifier of the job. in: path @@ -61915,7 +63625,7 @@ paths: description: Response content: application/json: - schema: &465 + schema: &482 title: Job description: Information of a job execution in a workflow run type: object @@ -62262,9 +63972,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: - - *430 - - *431 - - *453 + - *447 + - *448 + - *470 responses: '302': description: Response @@ -62292,9 +64002,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: - - *430 - - *431 - - *453 + - *447 + - *448 + - *470 requestBody: required: false content: @@ -62316,7 +64026,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -62340,8 +64050,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Status response @@ -62391,8 +64101,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -62426,7 +64136,7 @@ paths: description: Empty response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -62455,8 +64165,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -62474,7 +64184,7 @@ paths: type: integer secrets: type: array - items: &467 + items: &484 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -62495,7 +64205,7 @@ paths: - created_at - updated_at examples: - default: &468 + default: &485 value: total_count: 2 secrets: @@ -62528,9 +64238,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *430 - - *431 - - *454 + - *447 + - *448 + - *471 - *19 responses: '200': @@ -62547,7 +64257,7 @@ paths: type: integer variables: type: array - items: &471 + items: &488 title: Actions Variable type: object properties: @@ -62581,7 +64291,7 @@ paths: - created_at - updated_at examples: - default: &472 + default: &489 value: total_count: 2 variables: @@ -62614,8 +64324,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -62624,12 +64334,12 @@ paths: schema: type: object properties: - enabled: &455 + enabled: &472 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *49 - selected_actions_url: *233 - sha_pinning_required: *50 + allowed_actions: *54 + selected_actions_url: *253 + sha_pinning_required: *55 required: - enabled examples: @@ -62659,8 +64369,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -62671,9 +64381,9 @@ paths: schema: type: object properties: - enabled: *455 - allowed_actions: *49 - sha_pinning_required: *50 + enabled: *472 + allowed_actions: *54 + sha_pinning_required: *55 required: - enabled examples: @@ -62704,14 +64414,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: &456 + schema: &473 type: object properties: access_level: @@ -62729,7 +64439,7 @@ paths: required: - access_level examples: - default: &457 + default: &474 value: access_level: organization x-github: @@ -62754,15 +64464,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: application/json: - schema: *456 + schema: *473 examples: - default: *457 + default: *474 responses: '204': description: Response @@ -62786,14 +64496,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *235 + schema: *255 examples: default: value: @@ -62817,8 +64527,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Empty response for successful settings update @@ -62828,7 +64538,7 @@ paths: required: true content: application/json: - schema: *236 + schema: *256 examples: default: summary: Set retention days @@ -62852,16 +64562,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *51 + schema: *56 examples: - default: *237 + default: *257 '404': *6 x-github: enabledForGitHubApps: true @@ -62880,8 +64590,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -62891,7 +64601,7 @@ paths: required: true content: application/json: - schema: *51 + schema: *56 examples: default: summary: Set approval policy to first time contributors @@ -62915,16 +64625,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *238 + schema: *258 examples: - default: *52 + default: *57 '403': *27 '404': *6 x-github: @@ -62944,15 +64654,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: application/json: - schema: *239 + schema: *259 examples: - default: *52 + default: *57 responses: '204': description: Empty response for successful settings update @@ -62976,16 +64686,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *54 + schema: *59 examples: - default: *55 + default: *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63008,8 +64718,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -63017,9 +64727,9 @@ paths: required: false content: application/json: - schema: *54 + schema: *59 examples: - selected_actions: *55 + selected_actions: *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63041,16 +64751,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *242 + schema: *262 examples: - default: *58 + default: *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63071,8 +64781,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Success response @@ -63083,9 +64793,9 @@ paths: required: true content: application/json: - schema: *243 + schema: *263 examples: - default: *58 + default: *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63112,8 +64822,8 @@ paths: in: query schema: type: string - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -63131,9 +64841,9 @@ paths: type: integer runners: type: array - items: *65 + items: *70 examples: - default: *66 + default: *71 headers: Link: *41 x-github: @@ -63157,8 +64867,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -63166,9 +64876,9 @@ paths: application/json: schema: type: array - items: *247 + items: *267 examples: - default: *248 + default: *268 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63190,8 +64900,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -63234,10 +64944,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *249 + '201': *269 '404': *6 '422': *7 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63265,16 +64975,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: - - *430 - - *431 + - *447 + - *448 responses: '201': description: Response content: application/json: - schema: *68 + schema: *73 examples: - default: *250 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63302,16 +65012,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: - - *430 - - *431 + - *447 + - *448 responses: '201': description: Response content: application/json: - schema: *68 + schema: *73 examples: - default: *251 + default: *271 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63333,17 +65043,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 responses: '200': description: Response content: application/json: - schema: *65 + schema: *70 examples: - default: *252 + default: *272 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63364,9 +65074,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 responses: '204': description: Response @@ -63392,11 +65102,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 responses: - '200': *70 + '200': *75 '404': *6 x-github: githubCloudOnly: false @@ -63418,9 +65128,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 requestBody: required: true content: @@ -63444,7 +65154,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -63468,9 +65178,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 requestBody: required: true content: @@ -63495,7 +65205,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -63519,11 +65229,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 responses: - '200': *253 + '200': *273 '404': *6 x-github: githubCloudOnly: false @@ -63550,12 +65260,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: - - *430 - - *431 - - *64 - - *254 + - *447 + - *448 + - *69 + - *274 responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -63581,9 +65291,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: - - *430 - - *431 - - &475 + - *447 + - *448 + - &492 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. @@ -63591,7 +65301,7 @@ paths: required: false schema: type: string - - &476 + - &493 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -63599,7 +65309,7 @@ paths: required: false schema: type: string - - &477 + - &494 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -63608,7 +65318,7 @@ paths: required: false schema: type: string - - &478 + - &495 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 @@ -63635,7 +65345,7 @@ paths: - pending - *17 - *19 - - &479 + - &496 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)." @@ -63644,7 +65354,7 @@ paths: schema: type: string format: date-time - - &458 + - &475 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -63653,13 +65363,13 @@ paths: schema: type: boolean default: false - - &480 + - &497 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &481 + - &498 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -63682,7 +65392,7 @@ paths: type: integer workflow_runs: type: array - items: &459 + items: &476 title: Workflow Run description: An invocation of a workflow type: object @@ -63799,7 +65509,7 @@ paths: type: - array - 'null' - items: *187 + items: *204 created_at: type: string format: date-time @@ -63860,7 +65570,7 @@ paths: head_commit: anyOf: - type: 'null' - - &503 + - &520 title: Simple Commit description: A commit. type: object @@ -63934,8 +65644,8 @@ paths: - timestamp - author - committer - repository: *246 - head_repository: *246 + repository: *266 + head_repository: *266 head_repository_id: type: integer examples: @@ -63975,7 +65685,7 @@ paths: - workflow_url - pull_requests examples: - default: &482 + default: &499 value: total_count: 1 workflow_runs: @@ -64211,24 +65921,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *430 - - *431 - - &460 + - *447 + - *448 + - &477 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *458 + - *475 responses: '200': description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: &463 + default: &480 value: id: 30433642 name: Build @@ -64469,9 +66179,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '204': description: Response @@ -64494,9 +66204,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '200': description: Response @@ -64624,15 +66334,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '201': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -64659,12 +66369,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 - *17 - *19 - - *461 + - *478 responses: '200': description: Response @@ -64680,9 +66390,9 @@ paths: type: integer artifacts: type: array - items: *447 + items: *464 examples: - default: *462 + default: *479 headers: Link: *41 x-github: @@ -64706,25 +66416,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *430 - - *431 - - *460 - - &464 + - *447 + - *448 + - *477 + - &481 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *458 + - *475 responses: '200': description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *463 + default: *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64747,10 +66457,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: - - *430 - - *431 - - *460 - - *464 + - *447 + - *448 + - *477 + - *481 - *17 - *19 responses: @@ -64768,9 +66478,9 @@ paths: type: integer jobs: type: array - items: *465 + items: *482 examples: - default: &466 + default: &483 value: total_count: 1 jobs: @@ -64883,10 +66593,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *430 - - *431 - - *460 - - *464 + - *447 + - *448 + - *477 + - *481 responses: '302': description: Response @@ -64914,19 +66624,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '202': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64949,9 +66659,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 requestBody: required: true content: @@ -65018,19 +66728,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '202': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65053,9 +66763,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 - 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 @@ -65085,9 +66795,9 @@ paths: type: integer jobs: type: array - items: *465 + items: *482 examples: - default: *466 + default: *483 headers: Link: *41 x-github: @@ -65112,9 +66822,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '302': description: Response @@ -65141,9 +66851,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '204': description: Response @@ -65170,9 +66880,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '200': description: Response @@ -65241,7 +66951,7 @@ paths: items: type: object properties: - type: &583 + type: &600 type: string description: The type of reviewer. enum: @@ -65252,7 +66962,7 @@ paths: reviewer: anyOf: - *4 - - *273 + - *293 required: - environment - wait_timer @@ -65327,9 +67037,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 requestBody: required: true content: @@ -65379,7 +67089,7 @@ paths: application/json: schema: type: array - items: &569 + items: &586 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -65491,7 +67201,7 @@ paths: - created_at - updated_at examples: - default: &570 + default: &587 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -65547,9 +67257,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 requestBody: required: false content: @@ -65571,7 +67281,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -65594,9 +67304,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 requestBody: required: false content: @@ -65618,7 +67328,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -65651,9 +67361,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '200': description: Response @@ -65790,8 +67500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -65809,9 +67519,9 @@ paths: type: integer secrets: type: array - items: *467 + items: *484 examples: - default: *468 + default: *485 headers: Link: *41 x-github: @@ -65836,16 +67546,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *469 + schema: *486 examples: - default: *470 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65867,17 +67577,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '200': description: Response content: application/json: - schema: *467 + schema: *484 examples: - default: &596 + default: &613 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -65903,9 +67613,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 requestBody: required: true content: @@ -65936,7 +67646,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -65962,9 +67672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '204': description: Response @@ -65989,9 +67699,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *430 - - *431 - - *454 + - *447 + - *448 + - *471 - *19 responses: '200': @@ -66008,9 +67718,9 @@ paths: type: integer variables: type: array - items: *471 + items: *488 examples: - default: *472 + default: *489 headers: Link: *41 x-github: @@ -66033,8 +67743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -66061,7 +67771,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -66086,17 +67796,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *430 - - *431 - - *259 + - *447 + - *448 + - *279 responses: '200': description: Response content: application/json: - schema: *471 + schema: *488 examples: - default: &597 + default: &614 value: name: USERNAME value: octocat @@ -66122,9 +67832,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *430 - - *431 - - *259 + - *447 + - *448 + - *279 requestBody: required: true content: @@ -66166,9 +67876,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *430 - - *431 - - *259 + - *447 + - *448 + - *279 responses: '204': description: Response @@ -66193,8 +67903,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -66212,7 +67922,7 @@ paths: type: integer workflows: type: array - items: &473 + items: &490 title: Workflow description: A GitHub Actions workflow type: object @@ -66330,9 +68040,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *430 - - *431 - - &474 + - *447 + - *448 + - &491 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -66347,7 +68057,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *490 examples: default: value: @@ -66380,9 +68090,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *430 - - *431 - - *474 + - *447 + - *448 + - *491 responses: '204': description: Response @@ -66407,9 +68117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *430 - - *431 - - *474 + - *447 + - *448 + - *491 responses: '204': description: Response @@ -66460,9 +68170,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *430 - - *431 - - *474 + - *447 + - *448 + - *491 responses: '204': description: Response @@ -66489,19 +68199,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: - - *430 - - *431 - - *474 - - *475 - - *476 - - *477 - - *478 + - *447 + - *448 + - *491 + - *492 + - *493 + - *494 + - *495 - *17 - *19 - - *479 - - *458 - - *480 - - *481 + - *496 + - *475 + - *497 + - *498 responses: '200': description: Response @@ -66517,9 +68227,9 @@ paths: type: integer workflow_runs: type: array - items: *459 + items: *476 examples: - default: *482 + default: *499 headers: Link: *41 x-github: @@ -66552,9 +68262,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *430 - - *431 - - *474 + - *447 + - *448 + - *491 responses: '200': description: Response @@ -66615,12 +68325,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *430 - - *431 - - *99 + - *447 + - *448 + - *104 - *17 - - *97 - - *98 + - *102 + - *103 - name: ref description: |- The Git reference for the activities you want to list. @@ -66784,8 +68494,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -66797,7 +68507,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '404': *6 @@ -66822,8 +68532,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: - - *430 - - *431 + - *447 + - *448 - name: assignee in: path required: true @@ -66859,8 +68569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -66972,11 +68682,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *430 - - *431 + - *447 + - *448 - *17 - - *97 - - *98 + - *102 + - *103 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -67029,7 +68739,7 @@ paths: initiator: type: string examples: - default: *483 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67049,8 +68759,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -67058,7 +68768,7 @@ paths: application/json: schema: type: array - items: &484 + items: &501 title: Autolink reference description: An autolink reference. type: object @@ -67117,8 +68827,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -67157,9 +68867,9 @@ paths: description: response content: application/json: - schema: *484 + schema: *501 examples: - default: &485 + default: &502 value: id: 1 key_prefix: TICKET- @@ -67190,9 +68900,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: - - *430 - - *431 - - &486 + - *447 + - *448 + - &503 name: autolink_id description: The unique identifier of the autolink. in: path @@ -67204,9 +68914,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *501 examples: - default: *485 + default: *502 '404': *6 x-github: githubCloudOnly: false @@ -67226,9 +68936,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: - - *430 - - *431 - - *486 + - *447 + - *448 + - *503 responses: '204': description: Response @@ -67252,8 +68962,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response if Dependabot is enabled @@ -67303,8 +69013,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -67325,8 +69035,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -67346,8 +69056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *430 - - *431 + - *447 + - *448 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -67385,7 +69095,7 @@ paths: - url protected: type: boolean - protection: &488 + protection: &505 title: Branch Protection description: Branch Protection type: object @@ -67428,7 +69138,7 @@ paths: required: - contexts - checks - enforce_admins: &491 + enforce_admins: &508 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -67445,7 +69155,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &493 + required_pull_request_reviews: &510 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -67467,7 +69177,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *273 + items: *293 apps: description: The list of apps with review dismissal access. @@ -67499,7 +69209,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *273 + items: *293 apps: description: The list of apps allowed to bypass pull request requirements. @@ -67529,7 +69239,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &490 + restrictions: &507 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -67592,7 +69302,7 @@ paths: type: string teams: type: array - items: *273 + items: *293 apps: type: array items: @@ -67822,9 +69532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *430 - - *431 - - &489 + - *447 + - *448 + - &506 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). @@ -67838,14 +69548,14 @@ paths: description: Response content: application/json: - schema: &499 + schema: &516 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &545 + commit: &562 title: Commit description: Commit type: object @@ -67884,7 +69594,7 @@ paths: author: anyOf: - type: 'null' - - &487 + - &504 title: Git User description: Metaproperties for Git author/committer information. @@ -67905,7 +69615,7 @@ paths: committer: anyOf: - type: 'null' - - *487 + - *504 message: type: string examples: @@ -67929,7 +69639,7 @@ paths: required: - sha - url - verification: &603 + verification: &620 title: Verification type: object properties: @@ -67965,14 +69675,14 @@ paths: author: oneOf: - *4 - - *257 + - *277 type: - 'null' - object committer: oneOf: - *4 - - *257 + - *277 type: - 'null' - object @@ -68009,7 +69719,7 @@ paths: type: integer files: type: array - items: &556 + items: &573 title: Diff Entry description: Diff Entry type: object @@ -68105,7 +69815,7 @@ paths: - self protected: type: boolean - protection: *488 + protection: *505 protection_url: type: string format: uri @@ -68214,7 +69924,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *444 + '301': *461 '404': *6 x-github: githubCloudOnly: false @@ -68236,15 +69946,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *488 + schema: *505 examples: default: value: @@ -68438,9 +70148,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -68700,7 +70410,7 @@ paths: url: type: string format: uri - required_status_checks: &496 + required_status_checks: &513 title: Status Check Policy description: Status Check Policy type: object @@ -68781,7 +70491,7 @@ paths: items: *4 teams: type: array - items: *273 + items: *293 apps: type: array items: *5 @@ -68799,7 +70509,7 @@ paths: items: *4 teams: type: array - items: *273 + items: *293 apps: type: array items: *5 @@ -68859,7 +70569,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *490 + restrictions: *507 required_conversation_resolution: type: object properties: @@ -68971,9 +70681,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -68998,17 +70708,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *491 + schema: *508 examples: - default: &492 + default: &509 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -69030,17 +70740,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *491 + schema: *508 examples: - default: *492 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69059,9 +70769,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -69086,17 +70796,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *493 + schema: *510 examples: - default: &494 + default: &511 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -69192,9 +70902,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -69292,9 +71002,9 @@ paths: description: Response content: application/json: - schema: *493 + schema: *510 examples: - default: *494 + default: *511 '422': *15 x-github: githubCloudOnly: false @@ -69315,9 +71025,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -69344,17 +71054,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *491 + schema: *508 examples: - default: &495 + default: &512 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -69377,17 +71087,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *491 + schema: *508 examples: - default: *495 + default: *512 '404': *6 x-github: githubCloudOnly: false @@ -69407,9 +71117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -69434,17 +71144,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *496 + schema: *513 examples: - default: &497 + default: &514 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -69470,9 +71180,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -69524,9 +71234,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *513 examples: - default: *497 + default: *514 '404': *6 '422': *15 x-github: @@ -69548,9 +71258,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -69574,9 +71284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response @@ -69610,9 +71320,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -69679,9 +71389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -69745,9 +71455,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: content: application/json: @@ -69813,15 +71523,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *490 + schema: *507 examples: default: value: @@ -69912,9 +71622,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -69937,9 +71647,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: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response @@ -69949,7 +71659,7 @@ paths: type: array items: *5 examples: - default: &498 + default: &515 value: - id: 1 slug: octoapp @@ -70006,9 +71716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70042,7 +71752,7 @@ paths: type: array items: *5 examples: - default: *498 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -70063,9 +71773,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70099,7 +71809,7 @@ paths: type: array items: *5 examples: - default: *498 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -70120,9 +71830,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70156,7 +71866,7 @@ paths: type: array items: *5 examples: - default: *498 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -70178,9 +71888,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: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response @@ -70188,9 +71898,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 '404': *6 x-github: githubCloudOnly: false @@ -70210,9 +71920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -70248,9 +71958,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 '422': *15 x-github: githubCloudOnly: false @@ -70271,9 +71981,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -70309,9 +72019,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 '422': *15 x-github: githubCloudOnly: false @@ -70332,9 +72042,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: content: application/json: @@ -70369,9 +72079,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 '422': *15 x-github: githubCloudOnly: false @@ -70393,9 +72103,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: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response @@ -70405,7 +72115,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 '404': *6 x-github: githubCloudOnly: false @@ -70429,9 +72139,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70464,7 +72174,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 '422': *15 x-github: githubCloudOnly: false @@ -70489,9 +72199,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70524,7 +72234,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 '422': *15 x-github: githubCloudOnly: false @@ -70549,9 +72259,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70584,7 +72294,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 '422': *15 x-github: githubCloudOnly: false @@ -70611,9 +72321,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70635,7 +72345,7 @@ paths: description: Response content: application/json: - schema: *499 + schema: *516 examples: default: value: @@ -70749,12 +72459,12 @@ paths: category: repos subcategory: bypass-requests parameters: - - *430 - - *431 - - *92 - - *93 - - *94 - - *95 + - *447 + - *448 + - *97 + - *98 + - *99 + - *100 - *17 - *19 responses: @@ -70764,9 +72474,9 @@ paths: application/json: schema: type: array - items: *268 + items: *288 examples: - default: *269 + default: *289 '404': *6 '500': *38 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -70786,8 +72496,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: bypass_request_number in: path required: true @@ -70801,7 +72511,7 @@ paths: description: Response content: application/json: - schema: *268 + schema: *288 examples: default: value: @@ -70860,12 +72570,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *430 - - *431 - - *92 - - *93 - - *94 - - *95 + - *447 + - *448 + - *97 + - *98 + - *99 + - *100 - *17 - *19 responses: @@ -70875,9 +72585,9 @@ paths: application/json: schema: type: array - items: *271 + items: *291 examples: - default: *272 + default: *292 '404': *6 '403': *27 '500': *38 @@ -70901,8 +72611,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *430 - - *431 + - *447 + - *448 - name: bypass_request_number in: path required: true @@ -70914,7 +72624,7 @@ paths: description: A single bypass request. content: application/json: - schema: *271 + schema: *291 examples: default: value: @@ -70972,8 +72682,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *430 - - *431 + - *447 + - *448 - name: bypass_request_number in: path required: true @@ -71044,8 +72754,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *430 - - *431 + - *447 + - *448 - name: bypass_response_id in: path required: true @@ -71078,8 +72788,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -71358,7 +73068,7 @@ paths: description: Response content: application/json: - schema: &500 + schema: &517 title: CheckRun description: A check performed on the code of a given code change type: object @@ -71493,8 +73203,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *187 - deployment: &818 + items: *204 + deployment: &836 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -71781,9 +73491,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *430 - - *431 - - &501 + - *447 + - *448 + - &518 name: check_run_id description: The unique identifier of the check run. in: path @@ -71795,9 +73505,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *517 examples: - default: &502 + default: &519 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -71897,9 +73607,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *430 - - *431 - - *501 + - *447 + - *448 + - *518 requestBody: required: true content: @@ -72139,9 +73849,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *517 examples: - default: *502 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72161,9 +73871,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *430 - - *431 - - *501 + - *447 + - *448 + - *518 - *17 - *19 responses: @@ -72273,15 +73983,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *430 - - *431 - - *501 + - *447 + - *448 + - *518 responses: '201': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -72319,8 +74029,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -72342,7 +74052,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &504 + schema: &521 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -72424,12 +74134,12 @@ paths: type: - array - 'null' - items: *187 + items: *204 app: anyOf: - type: 'null' - *5 - repository: *246 + repository: *266 created_at: type: - string @@ -72440,7 +74150,7 @@ paths: - string - 'null' format: date-time - head_commit: *503 + head_commit: *520 latest_check_runs_count: type: integer check_runs_url: @@ -72468,7 +74178,7 @@ paths: - check_runs_url - pull_requests examples: - default: &505 + default: &522 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -72759,9 +74469,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *504 + schema: *521 examples: - default: *505 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72780,8 +74490,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -72842,7 +74552,7 @@ paths: required: - app_id - setting - repository: *246 + repository: *266 examples: default: value: @@ -73090,9 +74800,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *430 - - *431 - - &506 + - *447 + - *448 + - &523 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -73104,9 +74814,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *521 examples: - default: *505 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73129,17 +74839,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: - - *430 - - *431 - - *506 - - &551 + - *447 + - *448 + - *523 + - &568 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &552 + - &569 name: status description: Returns check runs with the specified `status`. in: query @@ -73178,9 +74888,9 @@ paths: type: integer check_runs: type: array - items: *500 + items: *517 examples: - default: &553 + default: &570 value: total_count: 1 check_runs: @@ -73282,15 +74992,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *430 - - *431 - - *506 + - *447 + - *448 + - *523 responses: '201': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -73317,30 +75027,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: - - *430 - - *431 - - *277 - - *278 + - *447 + - *448 + - *297 + - *298 - *19 - *17 - - &522 + - &539 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: *507 - - &523 + schema: *524 + - &540 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *99 - - *97 - - *98 + - *104 + - *102 + - *103 - name: sort description: The property by which to sort the results. in: query @@ -73356,13 +75066,13 @@ paths: be returned. in: query required: false - schema: *279 + schema: *299 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *508 + schema: *525 responses: '200': description: Response @@ -73373,24 +75083,24 @@ paths: items: type: object properties: - number: *109 - created_at: *116 - updated_at: *117 - url: *114 - html_url: *115 - instances_url: *509 - state: *102 - fixed_at: *119 + number: *119 + created_at: *126 + updated_at: *127 + url: *124 + html_url: *125 + instances_url: *526 + state: *107 + fixed_at: *129 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *118 - dismissed_reason: *510 - dismissed_comment: *511 - rule: *512 - tool: *513 - most_recent_instance: *514 + dismissed_at: *128 + dismissed_reason: *527 + dismissed_comment: *528 + rule: *529 + tool: *530 + most_recent_instance: *531 dismissal_approved_by: anyOf: - type: 'null' @@ -73513,14 +75223,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &515 + '403': &532 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73540,9 +75250,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: - - *430 - - *431 - - &516 + - *447 + - *448 + - &533 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -73550,30 +75260,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *109 + schema: *119 responses: '200': description: Response content: application/json: - schema: &517 + schema: &534 type: object properties: - number: *109 - created_at: *116 - updated_at: *117 - url: *114 - html_url: *115 - instances_url: *509 - state: *102 - fixed_at: *119 + number: *119 + created_at: *126 + updated_at: *127 + url: *124 + html_url: *125 + instances_url: *526 + state: *107 + fixed_at: *129 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *118 - dismissed_reason: *510 - dismissed_comment: *511 + dismissed_at: *128 + dismissed_reason: *527 + dismissed_comment: *528 rule: type: object properties: @@ -73635,8 +75345,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *513 - most_recent_instance: *514 + tool: *530 + most_recent_instance: *531 dismissal_approved_by: anyOf: - type: 'null' @@ -73732,9 +75442,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73752,9 +75462,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 requestBody: required: true content: @@ -73769,8 +75479,8 @@ paths: enum: - open - dismissed - dismissed_reason: *510 - dismissed_comment: *511 + dismissed_reason: *527 + dismissed_comment: *528 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -73789,7 +75499,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *534 examples: default: value: @@ -73865,14 +75575,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &521 + '403': &538 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': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -73892,15 +75602,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 responses: '200': description: Response content: application/json: - schema: &518 + schema: &535 type: object properties: status: @@ -73927,13 +75637,13 @@ paths: - description - started_at examples: - default: &519 + default: &536 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &520 + '400': &537 description: Bad Request content: application/json: @@ -73944,9 +75654,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': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73969,29 +75679,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 responses: '200': description: OK content: application/json: - schema: *518 + schema: *535 examples: - default: *519 + default: *536 '202': description: Accepted content: application/json: - schema: *518 + schema: *535 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *520 + '400': *537 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -74001,7 +75711,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74023,9 +75733,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 requestBody: required: false content: @@ -74071,12 +75781,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *520 - '403': *521 + '400': *537 + '403': *538 '404': *6 '422': description: Unprocessable Entity - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74096,13 +75806,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 - *19 - *17 - - *522 - - *523 + - *539 + - *540 responses: '200': description: Response @@ -74110,7 +75820,7 @@ paths: application/json: schema: type: array - items: *514 + items: *531 examples: default: value: @@ -74149,9 +75859,9 @@ paths: end_column: 50 classifications: - source - '403': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74183,30 +75893,30 @@ 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: - - *430 - - *431 - - *277 - - *278 + - *447 + - *448 + - *297 + - *298 - *19 - *17 - - *523 + - *540 - 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: *507 + schema: *524 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &526 + schema: &543 type: string description: An identifier for the upload. examples: - 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *99 + - *104 - name: sort description: The property by which to sort the results. in: query @@ -74223,23 +75933,23 @@ paths: application/json: schema: type: array - items: &527 + items: &544 type: object properties: - ref: *507 - commit_sha: &535 + ref: *524 + commit_sha: &552 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: *524 + analysis_key: *541 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *525 + category: *542 error: type: string examples: @@ -74264,8 +75974,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *526 - tool: *513 + sarif_id: *543 + tool: *530 deletable: type: boolean warning: @@ -74327,9 +76037,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74363,8 +76073,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: - - *430 - - *431 + - *447 + - *448 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74377,7 +76087,7 @@ paths: description: Response content: application/json: - schema: *527 + schema: *544 examples: response: summary: application/json response @@ -74431,14 +76141,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *515 + '403': *532 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74518,8 +76228,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: - - *430 - - *431 + - *447 + - *448 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74575,9 +76285,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': *521 + '403': *538 '404': *6 - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74597,8 +76307,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -74606,7 +76316,7 @@ paths: application/json: schema: type: array - items: &528 + items: &545 title: CodeQL Database description: A CodeQL database. type: object @@ -74718,9 +76428,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': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74747,8 +76457,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: - - *430 - - *431 + - *447 + - *448 - name: language in: path description: The language of the CodeQL database. @@ -74760,7 +76470,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *545 examples: default: value: @@ -74792,11 +76502,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': &558 + '302': &575 description: Found - '403': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74816,8 +76526,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *430 - - *431 + - *447 + - *448 - name: language in: path description: The language of the CodeQL database. @@ -74827,9 +76537,9 @@ paths: responses: '204': description: Response - '403': *521 + '403': *538 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74855,8 +76565,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -74865,7 +76575,7 @@ paths: type: object additionalProperties: false properties: - language: &529 + language: &546 type: string description: The language targeted by the CodeQL query enum: @@ -74944,7 +76654,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &533 + schema: &550 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -74952,9 +76662,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *108 + controller_repo: *113 actor: *4 - query_language: *529 + query_language: *546 query_pack_url: type: string description: The download url for the query pack. @@ -75002,7 +76712,7 @@ paths: items: type: object properties: - repository: &530 + repository: &547 title: Repository Identifier description: Repository Identifier type: object @@ -75044,7 +76754,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &534 + analysis_status: &551 type: string description: The new status of the CodeQL variant analysis repository task. @@ -75076,7 +76786,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &531 + access_mismatch_repos: &548 type: object properties: repository_count: @@ -75091,7 +76801,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: *530 + items: *547 required: - repository_count - repositories @@ -75114,8 +76824,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *531 - over_limit_repos: *531 + no_codeql_db_repos: *548 + over_limit_repos: *548 required: - access_mismatch_repos - not_found_repos @@ -75131,7 +76841,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &532 + value: &549 summary: Default response value: id: 1 @@ -75283,17 +76993,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *532 + value: *549 repository_lists: summary: Response for a successful variant analysis submission - value: *532 + value: *549 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75314,8 +77024,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: - - *430 - - *431 + - *447 + - *448 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -75327,11 +77037,11 @@ paths: description: Response content: application/json: - schema: *533 + schema: *550 examples: - default: *532 + default: *549 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75352,7 +77062,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: - - *430 + - *447 - name: repo in: path description: The name of the controller repository. @@ -75386,8 +77096,8 @@ paths: schema: type: object properties: - repository: *108 - analysis_status: *534 + repository: *113 + analysis_status: *551 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -75491,7 +77201,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75512,8 +77222,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -75606,9 +77316,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75627,8 +77337,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -75697,7 +77407,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -75722,7 +77432,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *521 + '403': *538 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -75736,7 +77446,7 @@ paths: content: application/json: schema: *3 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75793,8 +77503,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -75802,7 +77512,7 @@ paths: schema: type: object properties: - commit_sha: *535 + commit_sha: *552 ref: type: string description: |- @@ -75862,7 +77572,7 @@ paths: schema: type: object properties: - id: *526 + id: *543 url: type: string description: The REST API URL for checking the status of the upload. @@ -75876,11 +77586,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': *521 + '403': *538 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -75899,8 +77609,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: - - *430 - - *431 + - *447 + - *448 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -75948,10 +77658,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': *515 + '403': *532 '404': description: Not Found if the sarif id does not match any upload - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -75973,8 +77683,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -75998,7 +77708,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *103 + configuration: *108 examples: default: value: @@ -76030,7 +77740,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': *129 + '204': *139 '304': *35 '403': *27 '404': *6 @@ -76055,8 +77765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *430 - - *431 + - *447 + - *448 - 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 @@ -76184,8 +77894,8 @@ paths: parameters: - *17 - *19 - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -76201,7 +77911,7 @@ paths: type: integer codespaces: type: array - items: *336 + items: *354 examples: default: value: @@ -76499,8 +78209,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -76564,22 +78274,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76603,8 +78313,8 @@ paths: parameters: - *17 - *19 - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -76668,8 +78378,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: - - *430 - - *431 + - *447 + - *448 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -76706,9 +78416,9 @@ paths: type: integer machines: type: array - items: *537 + items: *554 examples: - default: &771 + default: &790 value: total_count: 2 machines: @@ -76748,8 +78458,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *430 - - *431 + - *447 + - *448 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -76836,8 +78546,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: - - *430 - - *431 + - *447 + - *448 - 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 @@ -76885,7 +78595,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76906,8 +78616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -76925,7 +78635,7 @@ paths: type: integer secrets: type: array - items: &541 + items: &558 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -76946,7 +78656,7 @@ paths: - created_at - updated_at examples: - default: *538 + default: *555 headers: Link: *41 x-github: @@ -76969,16 +78679,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *539 + schema: *556 examples: - default: *540 + default: *557 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76998,17 +78708,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '200': description: Response content: application/json: - schema: *541 + schema: *558 examples: - default: *542 + default: *559 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77028,9 +78738,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: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 requestBody: required: true content: @@ -77058,7 +78768,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -77082,9 +78792,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '204': description: Response @@ -77112,8 +78822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *430 - - *431 + - *447 + - *448 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -77151,7 +78861,7 @@ paths: application/json: schema: type: array - items: &543 + items: &560 title: Collaborator description: Collaborator type: object @@ -77344,9 +79054,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: - - *430 - - *431 - - *178 + - *447 + - *448 + - *194 responses: '204': description: Response if user is a collaborator @@ -77392,9 +79102,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *430 - - *431 - - *178 + - *447 + - *448 + - *194 requestBody: required: false content: @@ -77420,7 +79130,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &616 + schema: &633 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -77432,7 +79142,7 @@ paths: format: int64 examples: - 42 - repository: *246 + repository: *266 invitee: anyOf: - type: 'null' @@ -77608,7 +79318,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *223 + schema: *241 '403': *27 x-github: triggersNotification: true @@ -77648,9 +79358,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *430 - - *431 - - *178 + - *447 + - *448 + - *194 responses: '204': description: No Content when collaborator was removed from the repository. @@ -77681,9 +79391,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *430 - - *431 - - *178 + - *447 + - *448 + - *194 responses: '200': description: if user has admin permissions @@ -77703,7 +79413,7 @@ paths: user: anyOf: - type: 'null' - - *543 + - *560 required: - permission - role_name @@ -77757,8 +79467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -77768,7 +79478,7 @@ paths: application/json: schema: type: array - items: &544 + items: &561 title: Commit Comment description: Commit Comment type: object @@ -77809,8 +79519,8 @@ paths: updated_at: type: string format: date-time - author_association: *184 - reactions: *185 + author_association: *201 + reactions: *202 required: - url - html_url @@ -77826,7 +79536,7 @@ paths: - created_at - updated_at examples: - default: &547 + default: &564 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77885,17 +79595,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '200': description: Response content: application/json: - schema: *544 + schema: *561 examples: - default: &548 + default: &565 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77952,9 +79662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -77976,7 +79686,7 @@ paths: description: Response content: application/json: - schema: *544 + schema: *561 examples: default: value: @@ -78027,9 +79737,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '204': description: Response @@ -78050,9 +79760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 - 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. @@ -78078,9 +79788,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 '404': *6 @@ -78101,9 +79811,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -78135,16 +79845,16 @@ paths: description: Reaction exists content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Reaction created content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '422': *15 x-github: githubCloudOnly: false @@ -78166,10 +79876,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *430 - - *431 - - *198 - - *422 + - *447 + - *448 + - *215 + - *439 responses: '204': description: Response @@ -78218,8 +79928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *430 - - *431 + - *447 + - *448 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -78275,9 +79985,9 @@ paths: application/json: schema: type: array - items: *545 + items: *562 examples: - default: &662 + default: &681 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78351,7 +80061,7 @@ paths: '500': *38 '400': *14 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78371,9 +80081,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *430 - - *431 - - &546 + - *447 + - *448 + - &563 name: commit_sha description: The SHA of the commit. in: path @@ -78420,7 +80130,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78445,9 +80155,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *430 - - *431 - - *546 + - *447 + - *448 + - *563 - *17 - *19 responses: @@ -78457,9 +80167,9 @@ paths: application/json: schema: type: array - items: *544 + items: *561 examples: - default: *547 + default: *564 headers: Link: *41 x-github: @@ -78487,9 +80197,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *430 - - *431 - - *546 + - *447 + - *448 + - *563 requestBody: required: true content: @@ -78524,9 +80234,9 @@ paths: description: Response content: application/json: - schema: *544 + schema: *561 examples: - default: *548 + default: *565 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78554,9 +80264,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: - - *430 - - *431 - - *546 + - *447 + - *448 + - *563 - *17 - *19 responses: @@ -78566,9 +80276,9 @@ paths: application/json: schema: type: array - items: *549 + items: *566 examples: - default: &654 + default: &673 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -79048,7 +80758,7 @@ paths: draft: false headers: Link: *41 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79105,11 +80815,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *430 - - *431 + - *447 + - *448 - *19 - *17 - - &550 + - &567 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)" @@ -79124,9 +80834,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *562 examples: - default: &642 + default: &659 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -79213,8 +80923,8 @@ paths: '422': *15 '404': *6 '500': *38 - '503': *163 - '409': *107 + '503': *179 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79239,11 +80949,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: - - *430 - - *431 - - *550 - - *551 - - *552 + - *447 + - *448 + - *567 + - *568 + - *569 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -79277,9 +80987,9 @@ paths: type: integer check_runs: type: array - items: *500 + items: *517 examples: - default: *553 + default: *570 headers: Link: *41 x-github: @@ -79304,9 +81014,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: - - *430 - - *431 - - *550 + - *447 + - *448 + - *567 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -79314,7 +81024,7 @@ paths: schema: type: integer example: 1 - - *551 + - *568 - *17 - *19 responses: @@ -79332,7 +81042,7 @@ paths: type: integer check_suites: type: array - items: *504 + items: *521 examples: default: value: @@ -79532,9 +81242,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: - - *430 - - *431 - - *550 + - *447 + - *448 + - *567 - *17 - *19 responses: @@ -79605,7 +81315,7 @@ paths: type: string total_count: type: integer - repository: *246 + repository: *266 commit_url: type: string format: uri @@ -79736,9 +81446,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *430 - - *431 - - *550 + - *447 + - *448 + - *567 - *17 - *19 responses: @@ -79748,7 +81458,7 @@ paths: application/json: schema: type: array - items: &716 + items: &735 title: Status description: The status of a commit. type: object @@ -79829,7 +81539,7 @@ paths: site_admin: false headers: Link: *41 - '301': *444 + '301': *461 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79857,8 +81567,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -79891,11 +81601,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *554 + - *571 code_of_conduct_file: anyOf: - type: 'null' - - &555 + - &572 title: Community Health File type: object properties: @@ -79911,23 +81621,23 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 contributing: anyOf: - type: 'null' - - *555 + - *572 readme: anyOf: - type: 'null' - - *555 + - *572 issue_template: anyOf: - type: 'null' - - *555 + - *572 pull_request_template: anyOf: - type: 'null' - - *555 + - *572 required: - code_of_conduct - code_of_conduct_file @@ -80056,8 +81766,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *430 - - *431 + - *447 + - *448 - *19 - *17 - name: basehead @@ -80105,8 +81815,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *545 - merge_base_commit: *545 + base_commit: *562 + merge_base_commit: *562 status: type: string enum: @@ -80130,10 +81840,10 @@ paths: - 6 commits: type: array - items: *545 + items: *562 files: type: array - items: *556 + items: *573 required: - url - html_url @@ -80377,7 +82087,7 @@ paths: module Test" '404': *6 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80419,8 +82129,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *430 - - *431 + - *447 + - *448 - name: path description: path parameter in: path @@ -80573,7 +82283,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &557 + response-if-content-is-a-file: &574 summary: Response if content is a file value: type: file @@ -80710,7 +82420,7 @@ paths: - size - type - url - - &667 + - &686 title: Content File description: Content File type: object @@ -80928,7 +82638,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *557 + response-if-content-is-a-file: *574 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -80997,7 +82707,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *558 + '302': *575 '304': *35 x-github: githubCloudOnly: false @@ -81020,8 +82730,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *430 - - *431 + - *447 + - *448 - name: path description: path parameter in: path @@ -81116,7 +82826,7 @@ paths: description: Response content: application/json: - schema: &559 + schema: &576 title: File Commit description: File Commit type: object @@ -81272,7 +82982,7 @@ paths: description: Response content: application/json: - schema: *559 + schema: *576 examples: example-for-creating-a-file: value: @@ -81326,7 +83036,7 @@ paths: schema: oneOf: - *3 - - &598 + - &615 description: Repository rule violation was detected type: object properties: @@ -81347,7 +83057,7 @@ paths: items: type: object properties: - placeholder_id: &708 + placeholder_id: &727 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -81379,8 +83089,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *430 - - *431 + - *447 + - *448 - name: path description: path parameter in: path @@ -81441,7 +83151,7 @@ paths: description: Response content: application/json: - schema: *559 + schema: *576 examples: default: value: @@ -81475,8 +83185,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *107 - '503': *163 + '409': *112 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81496,8 +83206,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *430 - - *431 + - *447 + - *448 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -81621,31 +83331,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *430 - - *431 - - *294 - - *295 - - *296 - - *297 + - *447 + - *448 + - *314 + - *315 + - *316 + - *317 - 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 - - *298 - - *560 - - *299 - - *300 - - *99 - - 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 + - *318 + - *577 + - *319 + - *320 + - *104 - 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)." @@ -81654,10 +83356,8 @@ paths: schema: type: integer default: 30 - - *97 - - *98 - - *301 - - *302 + - *102 + - *103 responses: '200': description: Response @@ -81665,11 +83365,11 @@ paths: application/json: schema: type: array - items: &563 + items: &580 type: object description: A Dependabot alert. properties: - number: *109 + number: *119 state: type: string description: The state of the Dependabot alert. @@ -81684,7 +83384,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *110 + package: *120 manifest_path: type: string description: The full path to the dependency manifest file, @@ -81715,13 +83415,13 @@ paths: - direct - transitive - - security_advisory: *561 - security_vulnerability: *113 - url: *114 - html_url: *115 - created_at: *116 - updated_at: *117 - dismissed_at: *118 + security_advisory: *578 + security_vulnerability: *123 + url: *124 + html_url: *125 + created_at: *126 + updated_at: *127 + dismissed_at: *128 dismissed_by: anyOf: - type: 'null' @@ -81745,8 +83445,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *119 - auto_dismissed_at: *562 + fixed_at: *129 + auto_dismissed_at: *579 required: - number - state @@ -81976,9 +83676,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *430 - - *431 - - &564 + - *447 + - *448 + - &581 name: alert_number in: path description: |- @@ -81987,13 +83687,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *109 + schema: *119 responses: '200': description: Response content: application/json: - schema: *563 + schema: *580 examples: default: value: @@ -82106,9 +83806,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *430 - - *431 - - *564 + - *447 + - *448 + - *581 requestBody: required: true content: @@ -82153,7 +83853,7 @@ paths: description: Response content: application/json: - schema: *563 + schema: *580 examples: default: value: @@ -82259,7 +83959,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *7 x-github: githubCloudOnly: false @@ -82282,8 +83982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -82301,7 +84001,7 @@ paths: type: integer secrets: type: array - items: &567 + items: &584 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -82355,16 +84055,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *565 + schema: *582 examples: - default: *566 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82384,15 +84084,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '200': description: Response content: application/json: - schema: *567 + schema: *584 examples: default: value: @@ -82418,9 +84118,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 requestBody: required: true content: @@ -82448,7 +84148,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -82472,9 +84172,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '204': description: Response @@ -82496,8 +84196,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: - - *430 - - *431 + - *447 + - *448 - 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 @@ -82671,8 +84371,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -82932,8 +84632,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -83016,7 +84716,7 @@ paths: - version - url additionalProperties: false - metadata: &568 + metadata: &585 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -83055,7 +84755,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *568 + metadata: *585 resolved: type: object description: A collection of resolved package dependencies. @@ -83069,7 +84769,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *568 + metadata: *585 relationship: type: string description: A notation of whether a dependency is requested @@ -83202,8 +84902,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *430 - - *431 + - *447 + - *448 - name: sha description: The SHA recorded at creation time. in: query @@ -83244,9 +84944,9 @@ paths: application/json: schema: type: array - items: *569 + items: *586 examples: - default: *570 + default: *587 headers: Link: *41 x-github: @@ -83312,8 +85012,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -83395,7 +85095,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *586 examples: simple-example: summary: Simple example @@ -83468,9 +85168,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *430 - - *431 - - &571 + - *447 + - *448 + - &588 name: deployment_id description: deployment_id parameter in: path @@ -83482,7 +85182,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *586 examples: default: value: @@ -83547,9 +85247,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *430 - - *431 - - *571 + - *447 + - *448 + - *588 responses: '204': description: Response @@ -83571,9 +85271,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *430 - - *431 - - *571 + - *447 + - *448 + - *588 - *17 - *19 responses: @@ -83583,7 +85283,7 @@ paths: application/json: schema: type: array - items: &572 + items: &589 title: Deployment Status description: The status of a deployment. type: object @@ -83747,9 +85447,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *430 - - *431 - - *571 + - *447 + - *448 + - *588 requestBody: required: true content: @@ -83824,9 +85524,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *589 examples: - default: &573 + default: &590 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83882,9 +85582,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *430 - - *431 - - *571 + - *447 + - *448 + - *588 - name: status_id in: path required: true @@ -83895,9 +85595,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *589 examples: - default: *573 + default: *590 '404': *6 x-github: githubCloudOnly: false @@ -83924,12 +85624,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 - - *574 - - *575 - - *576 - - *577 + - *447 + - *448 + - *591 + - *592 + - *593 + - *594 - *17 - *19 responses: @@ -83939,9 +85639,9 @@ paths: application/json: schema: type: array - items: *578 + items: *595 examples: - default: *579 + default: *596 '404': *6 '403': *27 '500': *38 @@ -83965,8 +85665,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: alert_number in: path required: true @@ -83978,7 +85678,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *578 + schema: *595 examples: default: value: @@ -84034,8 +85734,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: alert_number in: path required: true @@ -84094,12 +85794,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 - - *92 - - *93 - - *94 - - *580 + - *447 + - *448 + - *97 + - *98 + - *99 + - *597 - *17 - *19 responses: @@ -84109,9 +85809,9 @@ paths: application/json: schema: type: array - items: *581 + items: *598 examples: - default: *582 + default: *599 '404': *6 '403': *27 '500': *38 @@ -84136,8 +85836,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: alert_number in: path required: true @@ -84149,7 +85849,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *581 + schema: *598 examples: default: value: @@ -84207,8 +85907,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: alert_number in: path required: true @@ -84277,8 +85977,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -84335,8 +86035,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -84354,7 +86054,7 @@ paths: - 5 environments: type: array - items: &584 + items: &601 title: Environment description: Details of a deployment environment type: object @@ -84416,7 +86116,7 @@ paths: type: string examples: - wait_timer - wait_timer: &586 + wait_timer: &603 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -84458,11 +86158,11 @@ paths: items: type: object properties: - type: *583 + type: *600 reviewer: anyOf: - *4 - - *273 + - *293 required: - id - node_id @@ -84485,7 +86185,7 @@ paths: - id - node_id - type - deployment_branch_policy: &587 + deployment_branch_policy: &604 type: - object - 'null' @@ -84602,9 +86302,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *430 - - *431 - - &585 + - *447 + - *448 + - &602 name: environment_name in: path required: true @@ -84617,9 +86317,9 @@ paths: description: Response content: application/json: - schema: *584 + schema: *601 examples: - default: &588 + default: &605 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -84703,9 +86403,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 requestBody: required: false content: @@ -84715,7 +86415,7 @@ paths: - object - 'null' properties: - wait_timer: *586 + wait_timer: *603 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -84734,14 +86434,14 @@ paths: items: type: object properties: - type: *583 + type: *600 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *587 + deployment_branch_policy: *604 additionalProperties: false examples: default: @@ -84761,9 +86461,9 @@ paths: description: Response content: application/json: - schema: *584 + schema: *601 examples: - default: *588 + default: *605 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -84787,9 +86487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 responses: '204': description: Default response @@ -84814,9 +86514,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 - *17 - *19 responses: @@ -84835,7 +86535,7 @@ paths: - 2 branch_policies: type: array - items: &589 + items: &606 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -84896,9 +86596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 requestBody: required: true content: @@ -84946,9 +86646,9 @@ paths: description: Response content: application/json: - schema: *589 + schema: *606 examples: - example-wildcard: &590 + example-wildcard: &607 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -84990,10 +86690,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *430 - - *431 - - *585 - - &591 + - *447 + - *448 + - *602 + - &608 name: branch_policy_id in: path required: true @@ -85005,9 +86705,9 @@ paths: description: Response content: application/json: - schema: *589 + schema: *606 examples: - default: *590 + default: *607 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85026,10 +86726,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *430 - - *431 - - *585 - - *591 + - *447 + - *448 + - *602 + - *608 requestBody: required: true content: @@ -85058,9 +86758,9 @@ paths: description: Response content: application/json: - schema: *589 + schema: *606 examples: - default: *590 + default: *607 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85079,10 +86779,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *430 - - *431 - - *585 - - *591 + - *447 + - *448 + - *602 + - *608 responses: '204': description: Response @@ -85107,9 +86807,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: - - *585 - - *431 - - *430 + - *602 + - *448 + - *447 responses: '200': description: List of deployment protection rules @@ -85126,7 +86826,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &592 + items: &609 title: Deployment protection rule description: Deployment protection rule type: object @@ -85148,7 +86848,7 @@ paths: for the environment. examples: - true - app: &593 + app: &610 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -85251,9 +86951,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: - - *585 - - *431 - - *430 + - *602 + - *448 + - *447 requestBody: content: application/json: @@ -85274,9 +86974,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *592 + schema: *609 examples: - default: &594 + default: &611 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -85311,9 +87011,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: - - *585 - - *431 - - *430 + - *602 + - *448 + - *447 - *19 - *17 responses: @@ -85333,7 +87033,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *593 + items: *610 examples: default: value: @@ -85368,10 +87068,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: - - *430 - - *431 - - *585 - - &595 + - *447 + - *448 + - *602 + - &612 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -85383,9 +87083,9 @@ paths: description: Response content: application/json: - schema: *592 + schema: *609 examples: - default: *594 + default: *611 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85406,10 +87106,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: - - *585 - - *431 - - *430 - - *595 + - *602 + - *448 + - *447 + - *612 responses: '204': description: Response @@ -85435,9 +87135,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 - *17 - *19 responses: @@ -85455,9 +87155,9 @@ paths: type: integer secrets: type: array - items: *467 + items: *484 examples: - default: *468 + default: *485 headers: Link: *41 x-github: @@ -85482,17 +87182,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 responses: '200': description: Response content: application/json: - schema: *469 + schema: *486 examples: - default: *470 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85514,18 +87214,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *430 - - *431 - - *585 - - *256 + - *447 + - *448 + - *602 + - *276 responses: '200': description: Response content: application/json: - schema: *467 + schema: *484 examples: - default: *596 + default: *613 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85547,10 +87247,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *430 - - *431 - - *585 - - *256 + - *447 + - *448 + - *602 + - *276 requestBody: required: true content: @@ -85581,7 +87281,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -85607,10 +87307,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *430 - - *431 - - *585 - - *256 + - *447 + - *448 + - *602 + - *276 responses: '204': description: Default response @@ -85635,10 +87335,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *430 - - *431 - - *585 - - *454 + - *447 + - *448 + - *602 + - *471 - *19 responses: '200': @@ -85655,9 +87355,9 @@ paths: type: integer variables: type: array - items: *471 + items: *488 examples: - default: *472 + default: *489 headers: Link: *41 x-github: @@ -85680,9 +87380,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 requestBody: required: true content: @@ -85709,7 +87409,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -85734,18 +87434,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *430 - - *431 - - *585 - - *259 + - *447 + - *448 + - *602 + - *279 responses: '200': description: Response content: application/json: - schema: *471 + schema: *488 examples: - default: *597 + default: *614 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85766,10 +87466,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *430 - - *431 - - *259 - - *585 + - *447 + - *448 + - *279 + - *602 requestBody: required: true content: @@ -85811,10 +87511,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *430 - - *431 - - *259 - - *585 + - *447 + - *448 + - *279 + - *602 responses: '204': description: Response @@ -85836,8 +87536,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -85847,7 +87547,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: 200-response: value: @@ -85905,8 +87605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *430 - - *431 + - *447 + - *448 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -85928,7 +87628,7 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: default: value: @@ -86065,8 +87765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -86099,9 +87799,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - default: *445 + default: *462 '400': *14 '422': *15 '403': *27 @@ -86122,8 +87822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -86174,7 +87874,7 @@ paths: schema: type: string '404': *6 - '409': *107 + '409': *112 '403': *27 '422': description: Validation failed @@ -86182,8 +87882,8 @@ paths: application/json: schema: oneOf: - - *223 - - *598 + - *241 + - *615 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86208,8 +87908,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *430 - - *431 + - *447 + - *448 - name: file_sha in: path required: true @@ -86261,7 +87961,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86309,8 +88009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -86419,7 +88119,7 @@ paths: description: Response content: application/json: - schema: &599 + schema: &616 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -86596,7 +88296,7 @@ paths: type: string '422': *15 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86646,15 +88346,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *430 - - *431 - - *546 + - *447 + - *448 + - *563 responses: '200': description: Response content: application/json: - schema: *599 + schema: *616 examples: default: value: @@ -86685,7 +88385,7 @@ paths: payload: verified_at: '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86710,9 +88410,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *430 - - *431 - - &600 + - *447 + - *448 + - &617 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. @@ -86729,7 +88429,7 @@ paths: application/json: schema: type: array - items: &601 + items: &618 title: Git Reference description: Git references within a repository type: object @@ -86784,7 +88484,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *41 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86805,17 +88505,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *430 - - *431 - - *600 + - *447 + - *448 + - *617 responses: '200': description: Response content: application/json: - schema: *601 + schema: *618 examples: - default: &602 + default: &619 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -86825,7 +88525,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86844,8 +88544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -86874,16 +88574,16 @@ paths: description: Response content: application/json: - schema: *601 + schema: *618 examples: - default: *602 + default: *619 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86902,9 +88602,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *430 - - *431 - - *600 + - *447 + - *448 + - *617 requestBody: required: true content: @@ -86933,11 +88633,11 @@ paths: description: Response content: application/json: - schema: *601 + schema: *618 examples: - default: *602 + default: *619 '422': *15 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86953,16 +88653,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *430 - - *431 - - *600 + - *447 + - *448 + - *617 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87010,8 +88710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -87078,7 +88778,7 @@ paths: description: Response content: application/json: - schema: &604 + schema: &621 title: Git Tag description: Metadata for a Git tag type: object @@ -87134,7 +88834,7 @@ paths: - sha - type - url - verification: *603 + verification: *620 required: - sha - url @@ -87144,7 +88844,7 @@ paths: - tag - message examples: - default: &605 + default: &622 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -87171,7 +88871,7 @@ paths: schema: type: string '422': *15 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87217,8 +88917,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *430 - - *431 + - *447 + - *448 - name: tag_sha in: path required: true @@ -87229,11 +88929,11 @@ paths: description: Response content: application/json: - schema: *604 + schema: *621 examples: - default: *605 + default: *622 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87255,8 +88955,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -87330,7 +89030,7 @@ paths: description: Response content: application/json: - schema: &606 + schema: &623 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -87409,7 +89109,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87432,8 +89132,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *430 - - *431 + - *447 + - *448 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -87456,7 +89156,7 @@ paths: description: Response content: application/json: - schema: *606 + schema: *623 examples: default-response: summary: Default response @@ -87497,7 +89197,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87515,8 +89215,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -87526,7 +89226,7 @@ paths: application/json: schema: type: array - items: &607 + items: &624 title: Webhook description: Webhooks for repositories. type: object @@ -87589,7 +89289,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &849 + last_response: &867 title: Hook Response type: object properties: @@ -87666,8 +89366,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -87720,9 +89420,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *624 examples: - default: &608 + default: &625 value: type: Repository id: 12345678 @@ -87770,17 +89470,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 responses: '200': description: Response content: application/json: - schema: *607 + schema: *624 examples: - default: *608 + default: *625 '404': *6 x-github: githubCloudOnly: false @@ -87800,9 +89500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 requestBody: required: true content: @@ -87847,9 +89547,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *624 examples: - default: *608 + default: *625 '422': *15 '404': *6 x-github: @@ -87870,9 +89570,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 responses: '204': description: Response @@ -87896,9 +89596,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: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 responses: '200': description: Response @@ -87925,9 +89625,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: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 requestBody: required: false content: @@ -87971,11 +89671,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 - *17 - - *309 + - *327 responses: '200': description: Response @@ -87983,9 +89683,9 @@ paths: application/json: schema: type: array - items: *310 + items: *328 examples: - default: *311 + default: *329 '400': *14 '422': *15 x-github: @@ -88004,18 +89704,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: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 - *16 responses: '200': description: Response content: application/json: - schema: *312 + schema: *330 examples: - default: *313 + default: *331 '400': *14 '422': *15 x-github: @@ -88034,9 +89734,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: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 - *16 responses: '202': *37 @@ -88059,9 +89759,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 responses: '204': description: Response @@ -88086,9 +89786,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 responses: '204': description: Response @@ -88111,8 +89811,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response if immutable releases are enabled @@ -88160,11 +89860,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *430 - - *431 + - *447 + - *448 responses: - '204': *129 - '409': *107 + '204': *139 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88181,11 +89881,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *430 - - *431 + - *447 + - *448 responses: - '204': *129 - '409': *107 + '204': *139 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88239,14 +89939,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: &609 + schema: &626 title: Import description: A repository import from an external source. type: object @@ -88353,7 +90053,7 @@ paths: - html_url - authors_url examples: - default: &612 + default: &629 value: vcs: subversion use_lfs: true @@ -88369,7 +90069,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': &610 + '503': &627 description: Unavailable due to service under maintenance. content: application/json: @@ -88398,8 +90098,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -88447,7 +90147,7 @@ paths: description: Response content: application/json: - schema: *609 + schema: *626 examples: default: value: @@ -88472,7 +90172,7 @@ paths: type: string '422': *15 '404': *6 - '503': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88500,8 +90200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -88553,7 +90253,7 @@ paths: description: Response content: application/json: - schema: *609 + schema: *626 examples: example-1: summary: Example 1 @@ -88601,7 +90301,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': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88624,12 +90324,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response - '503': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88655,9 +90355,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *430 - - *431 - - &793 + - *447 + - *448 + - &811 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -88671,7 +90371,7 @@ paths: application/json: schema: type: array - items: &611 + items: &628 title: Porter Author description: Porter Author type: object @@ -88725,7 +90425,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': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88750,8 +90450,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *430 - - *431 + - *447 + - *448 - name: author_id in: path required: true @@ -88781,7 +90481,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *628 examples: default: value: @@ -88794,7 +90494,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88818,8 +90518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -88860,7 +90560,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88888,8 +90588,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -88916,11 +90616,11 @@ paths: description: Response content: application/json: - schema: *609 + schema: *626 examples: - default: *612 + default: *629 '422': *15 - '503': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88943,8 +90643,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -88952,8 +90652,8 @@ paths: application/json: schema: *20 examples: - default: *613 - '301': *444 + default: *630 + '301': *461 '404': *6 x-github: githubCloudOnly: false @@ -88973,8 +90673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -88982,12 +90682,12 @@ paths: application/json: schema: anyOf: - - *326 + - *344 - type: object properties: {} additionalProperties: false examples: - default: &615 + default: &632 value: limit: collaborators_only origin: repository @@ -89012,13 +90712,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: application/json: - schema: *614 + schema: *631 examples: default: summary: Example request body @@ -89030,9 +90730,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *344 examples: - default: *615 + default: *632 '409': description: Response x-github: @@ -89054,8 +90754,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -89078,8 +90778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -89089,9 +90789,9 @@ paths: application/json: schema: type: array - items: *616 + items: *633 examples: - default: &786 + default: &804 value: - id: 1 repository: @@ -89222,9 +90922,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *430 - - *431 - - *330 + - *447 + - *448 + - *348 requestBody: required: false content: @@ -89253,7 +90953,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *633 examples: default: value: @@ -89384,9 +91084,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *430 - - *431 - - *330 + - *447 + - *448 + - *348 responses: '204': description: Response @@ -89417,8 +91117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *430 - - *431 + - *447 + - *448 - 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 @@ -89466,7 +91166,7 @@ paths: required: false schema: type: string - - *334 + - *352 - name: sort description: What to sort results by. in: query @@ -89478,8 +91178,8 @@ paths: - updated - comments default: created - - *99 - - *189 + - *104 + - *206 - *17 - *19 responses: @@ -89489,9 +91189,9 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: &623 + default: &640 value: - id: 1 node_id: MDU6SXNzdWUx @@ -89639,7 +91339,7 @@ paths: state_reason: completed headers: Link: *41 - '301': *444 + '301': *461 '422': *15 '404': *6 x-github: @@ -89668,8 +91368,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -89759,9 +91459,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: &620 + default: &637 value: id: 1 node_id: MDU6SXNzdWUx @@ -89915,9 +91615,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *163 + '503': *179 '404': *6 - '410': *441 + '410': *458 x-github: triggersNotification: true githubCloudOnly: false @@ -89945,9 +91645,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *430 - - *431 - - *206 + - *447 + - *448 + - *223 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -89957,7 +91657,7 @@ paths: enum: - asc - desc - - *189 + - *206 - *17 - *19 responses: @@ -89967,9 +91667,9 @@ paths: application/json: schema: type: array - items: *617 + items: *634 examples: - default: &622 + default: &639 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -90027,17 +91727,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '200': description: Response content: application/json: - schema: *617 + schema: *634 examples: - default: &618 + default: &635 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -90091,9 +91791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -90115,9 +91815,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *634 examples: - default: *618 + default: *635 '422': *15 x-github: githubCloudOnly: false @@ -90135,9 +91835,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '204': description: Response @@ -90157,9 +91857,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 - 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. @@ -90185,9 +91885,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 '404': *6 @@ -90208,9 +91908,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -90242,16 +91942,16 @@ paths: description: Reaction exists content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Reaction created content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '422': *15 x-github: githubCloudOnly: false @@ -90273,10 +91973,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *430 - - *431 - - *198 - - *422 + - *447 + - *448 + - *215 + - *439 responses: '204': description: Response @@ -90296,8 +91996,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -90307,7 +92007,7 @@ paths: application/json: schema: type: array - items: &619 + items: &636 title: Issue Event description: Issue Event type: object @@ -90354,7 +92054,7 @@ paths: issue: anyOf: - type: 'null' - - *183 + - *200 label: title: Issue Event Label description: Issue Event Label @@ -90387,7 +92087,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *273 + requested_team: *293 dismissed_review: title: Issue Event Dismissed Review type: object @@ -90454,7 +92154,7 @@ paths: required: - from - to - author_association: *184 + author_association: *201 lock_reason: type: - string @@ -90646,8 +92346,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *430 - - *431 + - *447 + - *448 - name: event_id in: path required: true @@ -90658,7 +92358,7 @@ paths: description: Response content: application/json: - schema: *619 + schema: *636 examples: default: value: @@ -90851,7 +92551,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *441 + '410': *458 '403': *27 x-github: githubCloudOnly: false @@ -90885,9 +92585,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *430 - - *431 - - &621 + - *447 + - *448 + - &638 name: issue_number description: The number that identifies the issue. in: path @@ -90899,12 +92599,12 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 - '301': *444 + default: *637 + '301': *461 '404': *6 - '410': *441 + '410': *458 '304': *35 x-github: githubCloudOnly: false @@ -90929,9 +92629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: false content: @@ -91050,15 +92750,15 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 '422': *15 - '503': *163 + '503': *179 '403': *27 - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91076,9 +92776,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: false content: @@ -91104,9 +92804,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91122,9 +92822,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: content: application/json: @@ -91149,9 +92849,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91173,9 +92873,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: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - name: assignee in: path required: true @@ -91215,10 +92915,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *430 - - *431 - - *621 - - *189 + - *447 + - *448 + - *638 + - *206 - *17 - *19 responses: @@ -91228,13 +92928,13 @@ paths: application/json: schema: type: array - items: *617 + items: *634 examples: - default: *622 + default: *639 headers: Link: *41 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91263,9 +92963,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -91287,16 +92987,16 @@ paths: description: Response content: application/json: - schema: *617 + schema: *634 examples: - default: *618 + default: *635 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *441 + '410': *458 '422': *15 '404': *6 x-github: @@ -91324,9 +93024,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: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -91336,14 +93036,14 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: *623 + default: *640 headers: Link: *41 - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91371,9 +93071,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: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -91395,17 +93095,17 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *444 + '301': *461 '403': *27 - '410': *441 + '410': *458 '422': *15 '404': *6 x-github: @@ -91436,9 +93136,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: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -91450,15 +93150,15 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 - '301': *444 + default: *637 + '301': *461 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *441 + '410': *458 x-github: triggersNotification: true githubCloudOnly: false @@ -91484,9 +93184,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: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -91496,14 +93196,14 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: *623 + default: *640 headers: Link: *41 - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91520,9 +93220,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -91536,7 +93236,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &625 + - &642 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -91585,7 +93285,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &626 + - &643 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -91713,7 +93413,7 @@ paths: - performed_via_github_app - assignee - assigner - - &627 + - &644 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91759,7 +93459,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &628 + - &645 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91805,7 +93505,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &629 + - &646 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91854,7 +93554,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &630 + - &647 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91883,7 +93583,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *273 + requested_team: *293 requested_reviewer: *4 required: - review_requester @@ -91896,7 +93596,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &631 + - &648 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91925,7 +93625,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *273 + requested_team: *293 requested_reviewer: *4 required: - review_requester @@ -91938,7 +93638,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &632 + - &649 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91994,7 +93694,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &633 + - &650 title: Locked Issue Event description: Locked Issue Event type: object @@ -92039,7 +93739,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &634 + - &651 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -92100,7 +93800,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &635 + - &652 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -92161,7 +93861,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &636 + - &653 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -92222,7 +93922,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &637 + - &654 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -92315,7 +94015,7 @@ paths: color: red headers: Link: *41 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92332,9 +94032,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -92344,9 +94044,9 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: - default: &624 + default: &641 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -92364,9 +94064,9 @@ paths: default: false headers: Link: *41 - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92383,9 +94083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: false content: @@ -92444,12 +94144,12 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: - default: *624 - '301': *444 + default: *641 + '301': *461 '404': *6 - '410': *441 + '410': *458 '422': *15 x-github: githubCloudOnly: false @@ -92466,9 +94166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: false content: @@ -92528,12 +94228,12 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: - default: *624 - '301': *444 + default: *641 + '301': *461 '404': *6 - '410': *441 + '410': *458 '422': *15 x-github: githubCloudOnly: false @@ -92550,15 +94250,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 responses: '204': description: Response - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92577,9 +94277,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - name: name in: path required: true @@ -92592,7 +94292,7 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: default: value: @@ -92603,9 +94303,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92625,9 +94325,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: false content: @@ -92656,7 +94356,7 @@ paths: '204': description: Response '403': *27 - '410': *441 + '410': *458 '404': *6 '422': *15 x-github: @@ -92674,9 +94374,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 responses: '204': description: Response @@ -92706,20 +94406,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 responses: '200': description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 - '301': *444 + default: *637 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92736,9 +94436,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - 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. @@ -92764,13 +94464,13 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92788,9 +94488,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -92822,16 +94522,16 @@ paths: description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '422': *15 x-github: githubCloudOnly: false @@ -92853,10 +94553,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *430 - - *431 - - *621 - - *422 + - *447 + - *448 + - *638 + - *439 responses: '204': description: Response @@ -92885,9 +94585,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -92909,9 +94609,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92944,9 +94644,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -92956,13 +94656,13 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: *623 + default: *640 headers: Link: *41 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92990,9 +94690,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -93019,16 +94719,16 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *441 + '410': *458 '422': *15 '404': *6 x-github: @@ -93048,9 +94748,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -93081,13 +94781,13 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 '403': *27 '404': *6 '422': *7 - '503': *163 + '503': *179 x-github: triggersNotification: true githubCloudOnly: false @@ -93105,9 +94805,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -93122,19 +94822,19 @@ paths: description: Timeline Event type: object anyOf: - - *625 - - *626 - - *627 - - *628 - - *629 - - *630 - - *631 - - *632 - - *633 - - *634 - - *635 - - *636 - - *637 + - *642 + - *643 + - *644 + - *645 + - *646 + - *647 + - *648 + - *649 + - *650 + - *651 + - *652 + - *653 + - *654 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -93182,12 +94882,12 @@ paths: issue_url: type: string format: uri - author_association: *184 + author_association: *201 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *185 + reactions: *202 required: - event - actor @@ -93218,7 +94918,7 @@ paths: properties: type: type: string - issue: *183 + issue: *200 required: - event - created_at @@ -93440,7 +95140,7 @@ paths: type: string body_text: type: string - author_association: *184 + author_association: *201 required: - event - id @@ -93463,7 +95163,7 @@ paths: type: string comments: type: array - items: &656 + items: &675 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -93568,7 +95268,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *184 + author_association: *201 _links: type: object properties: @@ -93663,7 +95363,7 @@ paths: enum: - line - file - reactions: *185 + reactions: *202 body_html: type: string examples: @@ -93701,7 +95401,7 @@ paths: type: string comments: type: array - items: *544 + items: *561 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93976,7 +95676,7 @@ paths: headers: Link: *41 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93993,8 +95693,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -94004,7 +95704,7 @@ paths: application/json: schema: type: array - items: &638 + items: &655 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -94072,8 +95772,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -94109,9 +95809,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *655 examples: - default: &639 + default: &656 value: id: 1 key: ssh-rsa AAA... @@ -94145,9 +95845,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *430 - - *431 - - &640 + - *447 + - *448 + - &657 name: key_id description: The unique identifier of the key. in: path @@ -94159,9 +95859,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *655 examples: - default: *639 + default: *656 '404': *6 x-github: githubCloudOnly: false @@ -94179,9 +95879,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *430 - - *431 - - *640 + - *447 + - *448 + - *657 responses: '204': description: Response @@ -94201,8 +95901,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -94212,9 +95912,9 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: - default: *624 + default: *641 headers: Link: *41 '404': *6 @@ -94235,8 +95935,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -94272,9 +95972,9 @@ paths: description: Response content: application/json: - schema: *182 + schema: *199 examples: - default: &641 + default: &658 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -94306,8 +96006,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *430 - - *431 + - *447 + - *448 - name: name in: path required: true @@ -94318,9 +96018,9 @@ paths: description: Response content: application/json: - schema: *182 + schema: *199 examples: - default: *641 + default: *658 '404': *6 x-github: githubCloudOnly: false @@ -94337,8 +96037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *430 - - *431 + - *447 + - *448 - name: name in: path required: true @@ -94377,7 +96077,7 @@ paths: description: Response content: application/json: - schema: *182 + schema: *199 examples: default: value: @@ -94403,8 +96103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *430 - - *431 + - *447 + - *448 - name: name in: path required: true @@ -94430,8 +96130,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -94467,8 +96167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '202': *37 '403': @@ -94496,8 +96196,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -94523,9 +96223,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *430 - - *431 - - *522 + - *447 + - *448 + - *539 responses: '200': description: Response @@ -94591,7 +96291,7 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 required: - _links - git_url @@ -94672,8 +96372,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -94738,8 +96438,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -94773,9 +96473,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *545 + schema: *562 examples: - default: *642 + default: *659 '204': description: Response when already merged '404': @@ -94800,8 +96500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *430 - - *431 + - *447 + - *448 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94842,7 +96542,7 @@ paths: application/json: schema: type: array - items: *368 + items: *386 examples: default: value: @@ -94898,8 +96598,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -94939,9 +96639,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *386 examples: - default: &643 + default: &660 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -95000,9 +96700,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *430 - - *431 - - &644 + - *447 + - *448 + - &661 name: milestone_number description: The number that identifies the milestone. in: path @@ -95014,9 +96714,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *386 examples: - default: *643 + default: *660 '404': *6 x-github: githubCloudOnly: false @@ -95033,9 +96733,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *430 - - *431 - - *644 + - *447 + - *448 + - *661 requestBody: required: false content: @@ -95073,9 +96773,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *386 examples: - default: *643 + default: *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95091,9 +96791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *430 - - *431 - - *644 + - *447 + - *448 + - *661 responses: '204': description: Response @@ -95114,9 +96814,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: - - *430 - - *431 - - *644 + - *447 + - *448 + - *661 - *17 - *19 responses: @@ -95126,9 +96826,9 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: - default: *624 + default: *641 headers: Link: *41 x-github: @@ -95147,12 +96847,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: - - *430 - - *431 - - *645 - - *646 - - *189 - - *647 + - *447 + - *448 + - *662 + - *663 + - *206 + - *664 - *17 - *19 responses: @@ -95162,9 +96862,9 @@ paths: application/json: schema: type: array - items: *209 + items: *226 examples: - default: *648 + default: *665 headers: Link: *41 x-github: @@ -95188,8 +96888,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -95247,14 +96947,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: &649 + schema: &666 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -95398,7 +97098,7 @@ paths: - custom_404 - public examples: - default: &650 + default: &667 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -95439,8 +97139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -95495,11 +97195,11 @@ paths: description: Response content: application/json: - schema: *649 + schema: *666 examples: - default: *650 + default: *667 '422': *15 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95520,8 +97220,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -95608,7 +97308,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95629,14 +97329,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response '422': *15 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95656,8 +97356,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -95667,7 +97367,7 @@ paths: application/json: schema: type: array - items: &651 + items: &668 title: Page Build description: Page Build type: object @@ -95759,8 +97459,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *430 - - *431 + - *447 + - *448 responses: '201': description: Response @@ -95807,16 +97507,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *651 + schema: *668 examples: - default: &652 + default: &669 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95864,8 +97564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *430 - - *431 + - *447 + - *448 - name: build_id in: path required: true @@ -95876,9 +97576,9 @@ paths: description: Response content: application/json: - schema: *651 + schema: *668 examples: - default: *652 + default: *669 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95898,8 +97598,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -96007,9 +97707,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: - - *430 - - *431 - - &653 + - *447 + - *448 + - &670 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -96067,11 +97767,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *430 - - *431 - - *653 + - *447 + - *448 + - *670 responses: - '204': *129 + '204': *139 '404': *6 x-github: githubCloudOnly: false @@ -96096,8 +97796,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -96365,7 +98065,7 @@ paths: description: Empty response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -96392,8 +98092,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Private vulnerability reporting status @@ -96430,10 +98130,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: - - *430 - - *431 + - *447 + - *448 responses: - '204': *129 + '204': *139 '422': *14 x-github: githubCloudOnly: false @@ -96452,10 +98152,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: - - *430 - - *431 + - *447 + - *448 responses: - '204': *129 + '204': *139 '422': *14 x-github: githubCloudOnly: false @@ -96476,8 +98176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects parameters: - - *430 - - *431 + - *447 + - *448 - name: state description: Indicates the state of the projects to return. in: query @@ -96498,7 +98198,7 @@ paths: application/json: schema: type: array - items: *362 + items: *380 examples: default: value: @@ -96538,7 +98238,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *441 + '410': *458 '422': *7 x-github: githubCloudOnly: false @@ -96561,8 +98261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -96588,13 +98288,13 @@ paths: description: Response content: application/json: - schema: *362 + schema: *380 examples: - default: *440 + default: *457 '401': *23 '403': *27 '404': *6 - '410': *441 + '410': *458 '422': *7 x-github: githubCloudOnly: false @@ -96617,8 +98317,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -96626,16 +98326,9 @@ paths: application/json: schema: type: array - items: *376 + items: *140 examples: - default: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *671 '403': *27 '404': *6 x-github: @@ -96657,8 +98350,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -96670,19 +98363,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *376 + items: *140 required: - properties examples: - default: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *672 responses: '204': description: No Content when custom property values are successfully created @@ -96720,8 +98405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -96781,9 +98466,9 @@ paths: application/json: schema: type: array - items: *549 + items: *566 examples: - default: *654 + default: *673 headers: Link: *41 '304': *35 @@ -96815,8 +98500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -96883,7 +98568,7 @@ paths: description: Response content: application/json: - schema: &658 + schema: &677 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -97012,7 +98697,7 @@ paths: milestone: anyOf: - type: 'null' - - *368 + - *386 active_lock_reason: type: - string @@ -97067,7 +98752,7 @@ paths: type: - array - 'null' - items: *344 + items: *362 head: type: object properties: @@ -97075,7 +98760,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *72 sha: type: string user: *4 @@ -97092,7 +98777,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *72 sha: type: string user: *4 @@ -97105,14 +98790,14 @@ paths: _links: type: object properties: - comments: *369 - commits: *369 - statuses: *369 - html: *369 - issue: *369 - review_comments: *369 - review_comment: *369 - self: *369 + comments: *387 + commits: *387 + statuses: *387 + html: *387 + issue: *387 + review_comments: *387 + review_comment: *387 + self: *387 required: - comments - commits @@ -97122,8 +98807,8 @@ paths: - review_comments - review_comment - self - author_association: *184 - auto_merge: *655 + author_association: *201 + auto_merge: *674 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -97225,7 +98910,7 @@ paths: - merged_by - review_comments examples: - default: &659 + default: &678 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -97752,8 +99437,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *430 - - *431 + - *447 + - *448 - name: sort in: query required: false @@ -97772,7 +99457,7 @@ paths: enum: - asc - desc - - *189 + - *206 - *17 - *19 responses: @@ -97782,9 +99467,9 @@ paths: application/json: schema: type: array - items: *656 + items: *675 examples: - default: &661 + default: &680 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97861,17 +99546,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: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '200': description: Response content: application/json: - schema: *656 + schema: *675 examples: - default: &657 + default: &676 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97946,9 +99631,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: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -97970,9 +99655,9 @@ paths: description: Response content: application/json: - schema: *656 + schema: *675 examples: - default: *657 + default: *676 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97988,9 +99673,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: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '204': description: Response @@ -98011,9 +99696,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: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 - 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. @@ -98039,9 +99724,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 '404': *6 @@ -98062,9 +99747,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: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -98096,16 +99781,16 @@ paths: description: Reaction exists content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Reaction created content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '422': *15 x-github: githubCloudOnly: false @@ -98127,10 +99812,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *430 - - *431 - - *198 - - *422 + - *447 + - *448 + - *215 + - *439 responses: '204': description: Response @@ -98173,9 +99858,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *430 - - *431 - - &660 + - *447 + - *448 + - &679 name: pull_number description: The number that identifies the pull request. in: path @@ -98188,9 +99873,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *658 + schema: *677 examples: - default: *659 + default: *678 '304': *35 '404': *6 '406': @@ -98199,7 +99884,7 @@ paths: application/json: schema: *3 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98225,9 +99910,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: false content: @@ -98269,9 +99954,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *677 examples: - default: *659 + default: *678 '422': *15 '403': *27 x-github: @@ -98293,9 +99978,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: true content: @@ -98356,21 +100041,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '401': *23 '403': *27 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98396,10 +100081,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: - - *430 - - *431 - - *660 - - *206 + - *447 + - *448 + - *679 + - *223 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -98409,7 +100094,7 @@ paths: enum: - asc - desc - - *189 + - *206 - *17 - *19 responses: @@ -98419,9 +100104,9 @@ paths: application/json: schema: type: array - items: *656 + items: *675 examples: - default: *661 + default: *680 headers: Link: *41 x-github: @@ -98454,9 +100139,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: true content: @@ -98562,7 +100247,7 @@ paths: description: Response content: application/json: - schema: *656 + schema: *675 examples: example-for-a-multi-line-comment: value: @@ -98650,10 +100335,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: - - *430 - - *431 - - *660 - - *198 + - *447 + - *448 + - *679 + - *215 requestBody: required: true content: @@ -98675,7 +100360,7 @@ paths: description: Response content: application/json: - schema: *656 + schema: *675 examples: default: value: @@ -98761,9 +100446,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 - *17 - *19 responses: @@ -98773,9 +100458,9 @@ paths: application/json: schema: type: array - items: *545 + items: *562 examples: - default: *662 + default: *681 headers: Link: *41 x-github: @@ -98805,9 +100490,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 - *17 - *19 responses: @@ -98817,7 +100502,7 @@ paths: application/json: schema: type: array - items: *556 + items: *573 examples: default: value: @@ -98836,7 +100521,7 @@ paths: Link: *41 '422': *15 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98855,9 +100540,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 responses: '204': description: Response if pull request has been merged @@ -98880,9 +100565,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: false content: @@ -98994,9 +100679,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 responses: '200': description: Response @@ -99012,7 +100697,7 @@ paths: items: *4 teams: type: array - items: *273 + items: *293 required: - users - teams @@ -99071,9 +100756,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: false content: @@ -99110,7 +100795,7 @@ paths: description: Response content: application/json: - schema: *549 + schema: *566 examples: default: value: @@ -99646,9 +101331,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: true content: @@ -99682,7 +101367,7 @@ paths: description: Response content: application/json: - schema: *549 + schema: *566 examples: default: value: @@ -100187,9 +101872,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 - *17 - *19 responses: @@ -100199,7 +101884,7 @@ paths: application/json: schema: type: array - items: &663 + items: &682 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -100273,7 +101958,7 @@ paths: type: string body_text: type: string - author_association: *184 + author_association: *201 required: - id - node_id @@ -100355,9 +102040,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: false content: @@ -100447,9 +102132,9 @@ paths: description: Response content: application/json: - schema: *663 + schema: *682 examples: - default: &665 + default: &684 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -100512,10 +102197,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: - - *430 - - *431 - - *660 - - &664 + - *447 + - *448 + - *679 + - &683 name: review_id description: The unique identifier of the review. in: path @@ -100527,9 +102212,9 @@ paths: description: Response content: application/json: - schema: *663 + schema: *682 examples: - default: &666 + default: &685 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -100588,10 +102273,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: - - *430 - - *431 - - *660 - - *664 + - *447 + - *448 + - *679 + - *683 requestBody: required: true content: @@ -100614,7 +102299,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *682 examples: default: value: @@ -100676,18 +102361,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: - - *430 - - *431 - - *660 - - *664 + - *447 + - *448 + - *679 + - *683 responses: '200': description: Response content: application/json: - schema: *663 + schema: *682 examples: - default: *665 + default: *684 '422': *7 '404': *6 x-github: @@ -100714,10 +102399,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: - - *430 - - *431 - - *660 - - *664 + - *447 + - *448 + - *679 + - *683 - *17 - *19 responses: @@ -100811,13 +102496,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *184 + author_association: *201 _links: type: object properties: - self: *369 - html: *369 - pull_request: *369 + self: *387 + html: *387 + pull_request: *387 required: - self - html @@ -100826,7 +102511,7 @@ paths: type: string body_html: type: string - reactions: *185 + reactions: *202 side: description: The side of the first line of the range for a multi-line comment. @@ -100975,10 +102660,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: - - *430 - - *431 - - *660 - - *664 + - *447 + - *448 + - *679 + - *683 requestBody: required: true content: @@ -101007,7 +102692,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *682 examples: default: value: @@ -101070,10 +102755,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: - - *430 - - *431 - - *660 - - *664 + - *447 + - *448 + - *679 + - *683 requestBody: required: true content: @@ -101108,9 +102793,9 @@ paths: description: Response content: application/json: - schema: *663 + schema: *682 examples: - default: *666 + default: *685 '404': *6 '422': *7 '403': *27 @@ -101132,9 +102817,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: false content: @@ -101198,8 +102883,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *430 - - *431 + - *447 + - *448 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -101212,9 +102897,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *686 examples: - default: &668 + default: &687 value: type: file encoding: base64 @@ -101256,8 +102941,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: - - *430 - - *431 + - *447 + - *448 - name: dir description: The alternate path to look for a README file in: path @@ -101277,9 +102962,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *686 examples: - default: *668 + default: *687 '404': *6 '422': *15 x-github: @@ -101301,8 +102986,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -101312,7 +102997,7 @@ paths: application/json: schema: type: array - items: *669 + items: *688 examples: default: value: @@ -101406,8 +103091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -101483,9 +103168,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *688 examples: - default: &673 + default: &692 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -101590,9 +103275,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *430 - - *431 - - &671 + - *447 + - *448 + - &690 name: asset_id description: The unique identifier of the asset. in: path @@ -101604,9 +103289,9 @@ paths: description: Response content: application/json: - schema: *670 + schema: *689 examples: - default: &672 + default: &691 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 @@ -101641,7 +103326,7 @@ paths: type: User site_admin: false '404': *6 - '302': *558 + '302': *575 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101657,9 +103342,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *430 - - *431 - - *671 + - *447 + - *448 + - *690 requestBody: required: false content: @@ -101688,9 +103373,9 @@ paths: description: Response content: application/json: - schema: *670 + schema: *689 examples: - default: *672 + default: *691 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101706,9 +103391,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *430 - - *431 - - *671 + - *447 + - *448 + - *690 responses: '204': description: Response @@ -101732,8 +103417,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -101819,16 +103504,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *669 + schema: *688 examples: - default: *673 + default: *692 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101845,8 +103530,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *430 - - *431 + - *447 + - *448 - name: tag description: tag parameter in: path @@ -101859,9 +103544,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *688 examples: - default: *673 + default: *692 '404': *6 x-github: githubCloudOnly: false @@ -101883,9 +103568,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *430 - - *431 - - &674 + - *447 + - *448 + - &693 name: release_id description: The unique identifier of the release. in: path @@ -101899,9 +103584,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: *669 + schema: *688 examples: - default: *673 + default: *692 '401': description: Unauthorized x-github: @@ -101919,9 +103604,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 requestBody: required: false content: @@ -101985,9 +103670,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *688 examples: - default: *673 + default: *692 '404': description: Not Found if the discussion category name is invalid content: @@ -102008,9 +103693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 responses: '204': description: Response @@ -102030,9 +103715,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 - *17 - *19 responses: @@ -102042,7 +103727,7 @@ paths: application/json: schema: type: array - items: *670 + items: *689 examples: default: value: @@ -102124,9 +103809,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: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 - name: name in: query required: true @@ -102152,7 +103837,7 @@ paths: description: Response for successful upload content: application/json: - schema: *670 + schema: *689 examples: response-for-successful-upload: value: @@ -102207,9 +103892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 - 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. @@ -102233,9 +103918,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 '404': *6 @@ -102256,9 +103941,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 requestBody: required: true content: @@ -102288,16 +103973,16 @@ paths: description: Reaction exists content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Reaction created content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '422': *15 x-github: githubCloudOnly: false @@ -102319,10 +104004,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *430 - - *431 - - *674 - - *422 + - *447 + - *448 + - *693 + - *439 responses: '204': description: Response @@ -102346,9 +104031,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 - *17 - *19 responses: @@ -102364,8 +104049,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *138 - - &675 + - *154 + - &694 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -102385,68 +104070,68 @@ paths: type: integer description: The ID of the ruleset that includes this rule. - allOf: - - *139 - - *675 + - *155 + - *694 - allOf: - - *140 - - *675 + - *156 + - *694 - allOf: - - *141 - - *675 + - *157 + - *694 - allOf: - - *676 - - *675 + - *695 + - *694 - allOf: - - *142 - - *675 + - *158 + - *694 - allOf: - - *143 - - *675 + - *159 + - *694 - allOf: - - *144 - - *675 + - *160 + - *694 - allOf: - - *145 - - *675 + - *161 + - *694 - allOf: - - *146 - - *675 + - *162 + - *694 - allOf: - - *147 - - *675 + - *163 + - *694 - allOf: - - *148 - - *675 + - *164 + - *694 - allOf: - - *149 - - *675 + - *165 + - *694 - allOf: - - *150 - - *675 + - *166 + - *694 - allOf: - - *151 - - *675 + - *167 + - *694 - allOf: - - *152 - - *675 + - *168 + - *694 - allOf: - - *153 - - *675 + - *169 + - *694 - allOf: - - *154 - - *675 + - *170 + - *694 - allOf: - - *155 - - *675 + - *171 + - *694 - allOf: - - *156 - - *675 + - *172 + - *694 - allOf: - - *157 - - *675 + - *173 + - *694 - allOf: - - *677 - - *675 + - *696 + - *694 examples: default: value: @@ -102485,8 +104170,8 @@ paths: category: repos subcategory: rules parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 - name: includes_parents @@ -102497,7 +104182,7 @@ paths: schema: type: boolean default: true - - *678 + - *697 responses: '200': description: Response @@ -102505,7 +104190,7 @@ paths: application/json: schema: type: array - items: *158 + items: *174 examples: default: value: @@ -102552,8 +104237,8 @@ paths: category: repos subcategory: rules parameters: - - *430 - - *431 + - *447 + - *448 requestBody: description: Request body required: true @@ -102573,16 +104258,16 @@ paths: - tag - push default: branch - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 - conditions: *132 + items: *153 + conditions: *146 rules: type: array description: An array of rules within the ruleset. - items: *679 + items: *698 required: - name - enforcement @@ -102613,9 +104298,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: &688 + default: &707 value: id: 42 name: super cool ruleset @@ -102662,12 +104347,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *430 - - *431 - - *680 - - *94 - - *681 - - *682 + - *447 + - *448 + - *699 + - *99 + - *700 + - *701 - *17 - *19 responses: @@ -102675,9 +104360,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *702 examples: - default: *684 + default: *703 '404': *6 '500': *38 x-github: @@ -102698,17 +104383,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *430 - - *431 - - *685 + - *447 + - *448 + - *704 responses: '200': description: Response content: application/json: - schema: *686 + schema: *705 examples: - default: *687 + default: *706 '404': *6 '500': *38 x-github: @@ -102736,8 +104421,8 @@ paths: category: repos subcategory: rules parameters: - - *430 - - *431 + - *447 + - *448 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102757,9 +104442,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *688 + default: *707 '404': *6 '500': *38 put: @@ -102777,8 +104462,8 @@ paths: category: repos subcategory: rules parameters: - - *430 - - *431 + - *447 + - *448 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102803,16 +104488,16 @@ paths: - branch - tag - push - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 - conditions: *132 + items: *153 + conditions: *146 rules: description: An array of rules within the ruleset. type: array - items: *679 + items: *698 examples: default: value: @@ -102840,9 +104525,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *688 + default: *707 '404': *6 '500': *38 delete: @@ -102860,8 +104545,8 @@ paths: category: repos subcategory: rules parameters: - - *430 - - *431 + - *447 + - *448 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102884,8 +104569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 - name: ruleset_id @@ -102901,9 +104586,9 @@ paths: application/json: schema: type: array - items: *162 + items: *178 examples: - default: *383 + default: *400 '404': *6 '500': *38 x-github: @@ -102922,8 +104607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *430 - - *431 + - *447 + - *448 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102941,7 +104626,7 @@ paths: description: Response content: application/json: - schema: *384 + schema: *401 examples: default: value: @@ -102996,21 +104681,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: - - *430 - - *431 - - *385 - - *386 - - *387 - - *388 - - *99 + - *447 + - *448 + - *402 + - *403 + - *404 + - *405 + - *104 - *19 - *17 - - *689 - - *690 - - *389 - - *390 - - *391 - - *392 + - *708 + - *709 + - *406 + - *407 + - *408 + - *409 responses: '200': description: Response @@ -103018,24 +104703,24 @@ paths: application/json: schema: type: array - items: &694 + items: &713 type: object properties: - number: *109 - created_at: *116 + number: *119 + created_at: *126 updated_at: anyOf: - type: 'null' - - *117 - url: *114 - html_url: *115 + - *127 + url: *124 + html_url: *125 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *691 - resolution: *692 + state: *710 + resolution: *711 resolved_at: type: - string @@ -103129,7 +104814,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *693 + - *712 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -103252,7 +104937,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103274,16 +104959,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: - - *430 - - *431 - - *516 - - *392 + - *447 + - *448 + - *533 + - *409 responses: '200': description: Response content: application/json: - schema: *694 + schema: *713 examples: default: value: @@ -103314,7 +104999,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103335,9 +105020,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 requestBody: required: true content: @@ -103345,8 +105030,8 @@ paths: schema: type: object properties: - state: *691 - resolution: *692 + state: *710 + resolution: *711 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -103365,7 +105050,7 @@ paths: description: Response content: application/json: - schema: *694 + schema: *713 examples: default: value: @@ -103418,7 +105103,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -103440,9 +105125,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 - *19 - *17 responses: @@ -103453,7 +105138,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &869 + items: &887 type: object properties: type: @@ -103480,19 +105165,19 @@ paths: - commit details: oneOf: - - *695 - - *696 - - *697 - - *698 - - *699 - - *700 - - *701 - - *702 - - *703 - - *704 - - *705 - - *706 - - *707 + - *714 + - *715 + - *716 + - *717 + - *718 + - *719 + - *720 + - *721 + - *722 + - *723 + - *724 + - *725 + - *726 examples: default: value: @@ -103556,7 +105241,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103578,8 +105263,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -103587,14 +105272,14 @@ paths: schema: type: object properties: - reason: &709 + reason: &728 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *708 + placeholder_id: *727 required: - reason - placeholder_id @@ -103611,7 +105296,7 @@ paths: schema: type: object properties: - reason: *709 + reason: *728 expire_at: type: - string @@ -103635,7 +105320,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -103647,6 +105332,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 @@ -103655,13 +105343,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: - - *430 - - *431 + - *447 + - *448 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *163 + '503': *179 '200': description: Response content: @@ -103671,7 +105359,7 @@ paths: properties: incremental_scans: type: array - items: &710 + items: &729 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103699,15 +105387,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *710 + items: *729 backfill_scans: type: array - items: *710 + items: *729 custom_pattern_backfill_scans: type: array items: allOf: - - *710 + - *729 - type: object properties: pattern_name: @@ -103777,9 +105465,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *430 - - *431 - - *99 + - *447 + - *448 + - *104 - name: sort description: The property to sort the results by. in: query @@ -103791,8 +105479,8 @@ paths: - updated - published default: created - - *97 - - *98 + - *102 + - *103 - 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)." @@ -103822,9 +105510,9 @@ paths: application/json: schema: type: array - items: *711 + items: *730 examples: - default: *712 + default: *731 '400': *14 '404': *6 x-github: @@ -103847,8 +105535,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -103928,7 +105616,7 @@ paths: login: type: string description: The username of the user credited. - type: *397 + type: *414 required: - login - type @@ -104018,9 +105706,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *730 examples: - default: &714 + default: &733 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -104253,8 +105941,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -104367,7 +106055,7 @@ paths: description: Response content: application/json: - schema: *711 + schema: *730 examples: default: value: @@ -104514,17 +106202,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: - - *430 - - *431 - - *713 + - *447 + - *448 + - *732 responses: '200': description: Response content: application/json: - schema: *711 + schema: *730 examples: - default: *714 + default: *733 '403': *27 '404': *6 x-github: @@ -104548,9 +106236,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: - - *430 - - *431 - - *713 + - *447 + - *448 + - *732 requestBody: required: true content: @@ -104630,7 +106318,7 @@ paths: login: type: string description: The username of the user credited. - type: *397 + type: *414 required: - login - type @@ -104721,17 +106409,17 @@ paths: description: Response content: application/json: - schema: *711 + schema: *730 examples: - default: *714 - add_credit: *714 + default: *733 + add_credit: *733 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *223 + schema: *241 examples: invalid_state_transition: value: @@ -104762,9 +106450,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: - - *430 - - *431 - - *713 + - *447 + - *448 + - *732 responses: '202': *37 '400': *14 @@ -104791,17 +106479,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: - - *430 - - *431 - - *713 + - *447 + - *448 + - *732 responses: '202': description: Response content: application/json: - schema: *443 + schema: *460 examples: - default: *445 + default: *462 '400': *14 '422': *15 '403': *27 @@ -104827,8 +106515,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -104924,8 +106612,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104934,7 +106622,7 @@ paths: application/json: schema: type: array - items: &715 + items: &734 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104947,7 +106635,7 @@ paths: - 1124 - -435 '202': *37 - '204': *129 + '204': *139 '422': description: Repository contains more than 10,000 commits x-github: @@ -104967,8 +106655,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -105019,7 +106707,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *129 + '204': *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105046,8 +106734,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -105119,7 +106807,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *129 + '204': *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105141,8 +106829,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -105296,8 +106984,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -105307,7 +106995,7 @@ paths: application/json: schema: type: array - items: *715 + items: *734 examples: default: value: @@ -105320,7 +107008,7 @@ paths: - - 0 - 2 - 21 - '204': *129 + '204': *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105340,8 +107028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *430 - - *431 + - *447 + - *448 - name: sha in: path required: true @@ -105397,7 +107085,7 @@ paths: description: Response content: application/json: - schema: *716 + schema: *735 examples: default: value: @@ -105451,8 +107139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -105464,7 +107152,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -105484,14 +107172,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &717 + schema: &736 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -105564,8 +107252,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -105591,7 +107279,7 @@ paths: description: Response content: application/json: - schema: *717 + schema: *736 examples: default: value: @@ -105618,8 +107306,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -105639,8 +107327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -105722,8 +107410,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -105731,7 +107419,7 @@ paths: application/json: schema: type: array - items: &718 + items: &737 title: Tag protection description: Tag protection type: object @@ -105788,8 +107476,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -105812,7 +107500,7 @@ paths: description: Response content: application/json: - schema: *718 + schema: *737 examples: default: value: @@ -105843,8 +107531,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: - - *430 - - *431 + - *447 + - *448 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -105881,8 +107569,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *430 - - *431 + - *447 + - *448 - name: ref in: path required: true @@ -105918,8 +107606,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -105929,9 +107617,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 headers: Link: *41 '404': *6 @@ -105951,8 +107639,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *430 - - *431 + - *447 + - *448 - *19 - *17 responses: @@ -105960,7 +107648,7 @@ paths: description: Response content: application/json: - schema: &719 + schema: &738 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105972,7 +107660,7 @@ paths: required: - names examples: - default: &720 + default: &739 value: names: - octocat @@ -105995,8 +107683,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -106027,9 +107715,9 @@ paths: description: Response content: application/json: - schema: *719 + schema: *738 examples: - default: *720 + default: *739 '404': *6 '422': *7 x-github: @@ -106050,9 +107738,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *430 - - *431 - - &721 + - *447 + - *448 + - &740 name: per description: The time frame to display results for. in: query @@ -106083,7 +107771,7 @@ paths: - 128 clones: type: array - items: &722 + items: &741 title: Traffic type: object properties: @@ -106170,8 +107858,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -106265,8 +107953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -106329,9 +108017,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *430 - - *431 - - *721 + - *447 + - *448 + - *740 responses: '200': description: Response @@ -106352,7 +108040,7 @@ paths: - 3782 views: type: array - items: *722 + items: *741 required: - uniques - count @@ -106429,8 +108117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -106466,7 +108154,7 @@ paths: description: Response content: application/json: - schema: *246 + schema: *266 examples: default: value: @@ -106704,8 +108392,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -106728,8 +108416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -106751,8 +108439,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -106778,8 +108466,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *430 - - *431 + - *447 + - *448 - name: ref in: path required: true @@ -106871,9 +108559,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - default: *445 + default: *462 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106914,7 +108602,7 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: default: value: @@ -107024,7 +108712,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &730 + - &749 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -107034,7 +108722,7 @@ paths: type: string examples: - members - - &735 + - &754 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -107046,7 +108734,7 @@ paths: format: int32 examples: - 1 - - &736 + - &755 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -107090,7 +108778,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &725 + items: &744 allOf: - type: object required: @@ -107172,7 +108860,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: &737 + meta: &756 type: object description: The metadata associated with the creation/updates to the user. @@ -107237,30 +108925,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &726 + '400': &745 description: Bad request content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 - '401': *724 - '403': &727 + schema: *742 + '401': *743 + '403': &746 description: Permission denied - '429': &728 + '429': &747 description: Too many requests content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 - '500': &729 + schema: *742 + '500': &748 description: Internal server error content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 + schema: *742 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107284,7 +108972,7 @@ paths: required: true content: application/json: - schema: &733 + schema: &752 type: object required: - schemas @@ -107348,9 +109036,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *725 + schema: *744 examples: - group: &731 + group: &750 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -107369,13 +109057,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': *726 - '401': *724 - '403': *727 - '409': &734 + '400': *745 + '401': *743 + '403': *746 + '409': &753 description: Duplicate record detected - '429': *728 - '500': *729 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107392,7 +109080,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: - - &732 + - &751 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -107401,22 +109089,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *730 + - *749 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *725 + schema: *744 examples: - default: *731 - '400': *726 - '401': *724 - '403': *727 + default: *750 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '429': *728 - '500': *729 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107435,13 +109123,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: - - *732 + - *751 - *39 requestBody: required: true content: application/json: - schema: *733 + schema: *752 examples: group: summary: Group @@ -107467,17 +109155,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *725 + schema: *744 examples: - group: *731 - groupWithMembers: *731 - '400': *726 - '401': *724 - '403': *727 + group: *750 + groupWithMembers: *750 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '409': *734 - '429': *728 - '500': *729 + '409': *753 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107501,13 +109189,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: - - *732 + - *751 - *39 requestBody: required: true content: application/json: - schema: &744 + schema: &763 type: object required: - Operations @@ -107567,17 +109255,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *725 + schema: *744 examples: - updateGroup: *731 - addMembers: *731 - '400': *726 - '401': *724 - '403': *727 + updateGroup: *750 + addMembers: *750 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '409': *734 - '429': *728 - '500': *729 + '409': *753 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107593,17 +109281,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: - - *732 + - *751 - *39 responses: '204': description: Group was deleted, no content - '400': *726 - '401': *724 - '403': *727 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '429': *728 - '500': *729 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107637,8 +109325,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *735 - - *736 + - *754 + - *755 - *39 responses: '200': @@ -107672,7 +109360,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &739 + items: &758 allOf: - type: object required: @@ -107764,7 +109452,7 @@ paths: address. examples: - true - roles: &738 + roles: &757 type: array description: The roles assigned to the user. items: @@ -107823,7 +109511,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *737 + meta: *756 startIndex: type: integer description: A starting index for the returned page @@ -107862,11 +109550,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *726 - '401': *724 - '403': *727 - '429': *728 - '500': *729 + '400': *745 + '401': *743 + '403': *746 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107890,7 +109578,7 @@ paths: required: true content: application/json: - schema: &742 + schema: &761 type: object required: - schemas @@ -107983,9 +109671,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *738 + roles: *757 examples: - user: &743 + user: &762 summary: User value: schemas: @@ -108032,9 +109720,9 @@ paths: description: User has been created content: application/scim+json: - schema: *739 + schema: *758 examples: - user: &740 + user: &759 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -108060,13 +109748,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: *740 - '400': *726 - '401': *724 - '403': *727 - '409': *734 - '429': *728 - '500': *729 + enterpriseOwner: *759 + '400': *745 + '401': *743 + '403': *746 + '409': *753 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108083,7 +109771,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: - - &741 + - &760 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -108096,15 +109784,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *739 + schema: *758 examples: - default: *740 - '400': *726 - '401': *724 - '403': *727 + default: *759 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '429': *728 - '500': *729 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108126,30 +109814,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: - - *741 + - *760 - *39 requestBody: required: true content: application/json: - schema: *742 + schema: *761 examples: - user: *743 + user: *762 responses: '200': description: User was updated content: application/scim+json: - schema: *739 + schema: *758 examples: - user: *740 - '400': *726 - '401': *724 - '403': *727 + user: *759 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '409': *734 - '429': *728 - '500': *729 + '409': *753 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108184,13 +109872,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: - - *741 + - *760 - *39 requestBody: required: true content: application/json: - schema: *744 + schema: *763 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -108230,18 +109918,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *739 + schema: *758 examples: - userMultiValuedProperties: *740 - userSingleValuedProperties: *740 - disableUser: *740 - '400': *726 - '401': *724 - '403': *727 + userMultiValuedProperties: *759 + userSingleValuedProperties: *759 + disableUser: *759 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '409': *734 - '429': *728 - '500': *729 + '409': *753 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108261,17 +109949,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: - - *741 + - *760 - *39 responses: '204': description: User was deleted, no content - '400': *726 - '401': *724 - '403': *727 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '429': *728 - '500': *729 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108304,7 +109992,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *76 + - *81 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -108362,7 +110050,7 @@ paths: - 1 Resources: type: array - items: &745 + items: &764 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -108609,22 +110297,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': *35 - '404': &746 + '404': &765 description: Resource not found content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 - '403': &747 + schema: *742 + '403': &766 description: Forbidden content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 - '400': *726 - '429': *728 + schema: *742 + '400': *745 + '429': *747 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -108644,15 +110332,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *76 + - *81 responses: '201': description: Response content: application/scim+json: - schema: *745 + schema: *764 examples: - default: &748 + default: &767 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -108675,17 +110363,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': *35 - '404': *746 - '403': *747 - '500': *729 + '404': *765 + '403': *766 + '500': *748 '409': description: Conflict content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 - '400': *726 + schema: *742 + '400': *745 requestBody: required: true content: @@ -108784,18 +110472,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: - - *76 - - *741 + - *81 + - *760 responses: '200': description: Response content: application/scim+json: - schema: *745 + schema: *764 examples: - default: *748 - '404': *746 - '403': *747 + default: *767 + '404': *765 + '403': *766 '304': *35 x-github: githubCloudOnly: true @@ -108818,19 +110506,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *76 - - *741 + - *81 + - *760 responses: '200': description: Response content: application/scim+json: - schema: *745 + schema: *764 examples: - default: *748 + default: *767 '304': *35 - '404': *746 - '403': *747 + '404': *765 + '403': *766 requestBody: required: true content: @@ -108944,20 +110632,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: - - *76 - - *741 + - *81 + - *760 responses: '200': description: Response content: application/scim+json: - schema: *745 + schema: *764 examples: - default: *748 + default: *767 '304': *35 - '404': *746 - '403': *747 - '400': *726 + '404': *765 + '403': *766 + '400': *745 '429': description: Response content: @@ -109052,13 +110740,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: - - *76 - - *741 + - *81 + - *760 responses: '204': description: Response - '404': *746 - '403': *747 + '404': *765 + '403': *766 '304': *35 x-github: githubCloudOnly: true @@ -109173,7 +110861,7 @@ paths: html_url: type: string format: uri - repository: *246 + repository: *266 score: type: number file_size: @@ -109192,7 +110880,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &749 + text_matches: &768 title: Search Result Text Matches type: array items: @@ -109307,7 +110995,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *163 + '503': *179 '422': *15 '403': *27 x-github: @@ -109356,7 +111044,7 @@ paths: enum: - author-date - committer-date - - &750 + - &769 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 @@ -109425,7 +111113,7 @@ paths: committer: anyOf: - type: 'null' - - *487 + - *504 comment_count: type: integer message: @@ -109444,7 +111132,7 @@ paths: url: type: string format: uri - verification: *603 + verification: *620 required: - author - committer @@ -109459,7 +111147,7 @@ paths: committer: anyOf: - type: 'null' - - *487 + - *504 parents: type: array items: @@ -109471,12 +111159,12 @@ paths: type: string sha: type: string - repository: *246 + repository: *266 score: type: number node_id: type: string - text_matches: *749 + text_matches: *768 required: - sha - node_id @@ -109669,7 +111357,7 @@ paths: - interactions - created - updated - - *750 + - *769 - *17 - *19 - name: advanced_search @@ -109766,11 +111454,11 @@ paths: type: - string - 'null' - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: type: string state_reason: @@ -109784,7 +111472,7 @@ paths: milestone: anyOf: - type: 'null' - - *368 + - *386 comments: type: integer created_at: @@ -109798,7 +111486,7 @@ paths: - string - 'null' format: date-time - text_matches: *749 + text_matches: *768 pull_request: type: object properties: @@ -109836,10 +111524,10 @@ paths: type: string score: type: number - author_association: *184 + author_association: *201 draft: type: boolean - repository: *67 + repository: *72 body_html: type: string body_text: @@ -109847,12 +111535,12 @@ paths: timeline_url: type: string format: uri - type: *331 + type: *349 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *185 + reactions: *202 required: - assignee - closed_at @@ -109968,7 +111656,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *163 + '503': *179 '422': *15 '304': *35 '403': *27 @@ -110021,7 +111709,7 @@ paths: enum: - created - updated - - *750 + - *769 - *17 - *19 responses: @@ -110066,7 +111754,7 @@ paths: - 'null' score: type: number - text_matches: *749 + text_matches: *768 required: - id - node_id @@ -110152,7 +111840,7 @@ paths: - forks - help-wanted-issues - updated - - *750 + - *769 - *17 - *19 responses: @@ -110371,7 +112059,7 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 permissions: type: object properties: @@ -110389,7 +112077,7 @@ paths: - admin - pull - push - text_matches: *749 + text_matches: *768 temp_clone_token: type: string allow_merge_commit: @@ -110592,7 +112280,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *163 + '503': *179 '422': *15 '304': *35 x-github: @@ -110698,7 +112386,7 @@ paths: - string - 'null' format: uri - text_matches: *749 + text_matches: *768 related: type: - array @@ -110893,7 +112581,7 @@ paths: - followers - repositories - joined - - *750 + - *769 - *17 - *19 responses: @@ -111003,7 +112691,7 @@ paths: type: - boolean - 'null' - text_matches: *749 + text_matches: *768 blog: type: - string @@ -111065,7 +112753,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *163 + '503': *179 '422': *15 x-github: githubCloudOnly: false @@ -111085,7 +112773,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &754 + - &773 name: team_id description: The unique identifier of the team. in: path @@ -111097,9 +112785,9 @@ paths: description: Response content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '404': *6 x-github: githubCloudOnly: false @@ -111126,7 +112814,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *754 + - *773 requestBody: required: true content: @@ -111190,16 +112878,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '201': description: Response content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '404': *6 '422': *15 '403': *27 @@ -111227,7 +112915,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *754 + - *773 responses: '204': description: Response @@ -111258,8 +112946,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *754 - - *99 + - *773 + - *104 - *17 - *19 responses: @@ -111269,9 +112957,9 @@ paths: application/json: schema: type: array - items: *413 + items: *430 examples: - default: *755 + default: *774 headers: Link: *41 x-github: @@ -111300,7 +112988,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *754 + - *773 requestBody: required: true content: @@ -111334,9 +113022,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: *414 + default: *431 x-github: triggersNotification: true githubCloudOnly: false @@ -111363,16 +113051,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *754 - - *415 + - *773 + - *432 responses: '200': description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: *414 + default: *431 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111397,8 +113085,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *754 - - *415 + - *773 + - *432 requestBody: required: false content: @@ -111421,9 +113109,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: *756 + default: *775 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111448,8 +113136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *754 - - *415 + - *773 + - *432 responses: '204': description: Response @@ -111478,9 +113166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *754 - - *415 - - *99 + - *773 + - *432 + - *104 - *17 - *19 responses: @@ -111490,9 +113178,9 @@ paths: application/json: schema: type: array - items: *416 + items: *433 examples: - default: *757 + default: *776 headers: Link: *41 x-github: @@ -111521,8 +113209,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *754 - - *415 + - *773 + - *432 requestBody: required: true content: @@ -111544,9 +113232,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: *417 + default: *434 x-github: triggersNotification: true githubCloudOnly: false @@ -111573,17 +113261,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *754 - - *415 - - *418 + - *773 + - *432 + - *435 responses: '200': description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: *417 + default: *434 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111608,9 +113296,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *754 - - *415 - - *418 + - *773 + - *432 + - *435 requestBody: required: true content: @@ -111632,9 +113320,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: *758 + default: *777 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111659,9 +113347,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *754 - - *415 - - *418 + - *773 + - *432 + - *435 responses: '204': description: Response @@ -111690,9 +113378,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: - - *754 - - *415 - - *418 + - *773 + - *432 + - *435 - 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. @@ -111718,9 +113406,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 x-github: @@ -111749,9 +113437,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: - - *754 - - *415 - - *418 + - *773 + - *432 + - *435 requestBody: required: true content: @@ -111783,9 +113471,9 @@ paths: description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111811,8 +113499,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: - - *754 - - *415 + - *773 + - *432 - 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. @@ -111838,9 +113526,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 x-github: @@ -111869,8 +113557,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: - - *754 - - *415 + - *773 + - *432 requestBody: required: true content: @@ -111902,9 +113590,9 @@ paths: description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111928,7 +113616,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *754 + - *773 - *17 - *19 responses: @@ -111938,9 +113626,9 @@ paths: application/json: schema: type: array - items: *328 + items: *346 examples: - default: *329 + default: *347 headers: Link: *41 x-github: @@ -111966,7 +113654,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *754 + - *773 - name: role description: Filters members returned by their role in the team. in: query @@ -111989,7 +113677,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '404': *6 @@ -112017,8 +113705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *754 - - *178 + - *773 + - *194 responses: '204': description: if user is a member @@ -112054,8 +113742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *754 - - *178 + - *773 + - *194 responses: '204': description: Response @@ -112094,8 +113782,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *754 - - *178 + - *773 + - *194 responses: '204': description: Response @@ -112131,16 +113819,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: - - *754 - - *178 + - *773 + - *194 responses: '200': description: Response content: application/json: - schema: *427 + schema: *444 examples: - response-if-user-is-a-team-maintainer: *759 + response-if-user-is-a-team-maintainer: *778 '404': *6 x-github: githubCloudOnly: false @@ -112173,8 +113861,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: - - *754 - - *178 + - *773 + - *194 requestBody: required: false content: @@ -112199,9 +113887,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *444 examples: - response-if-users-membership-with-team-is-now-pending: *760 + response-if-users-membership-with-team-is-now-pending: *779 '403': description: Forbidden if team synchronization is set up '422': @@ -112235,8 +113923,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: - - *754 - - *178 + - *773 + - *194 responses: '204': description: Response @@ -112264,7 +113952,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *754 + - *773 - *17 - *19 responses: @@ -112274,9 +113962,9 @@ paths: application/json: schema: type: array - items: *428 + items: *445 examples: - default: *761 + default: *780 headers: Link: *41 '404': *6 @@ -112302,16 +113990,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: - - *754 - - *429 + - *773 + - *446 responses: '200': description: Response content: application/json: - schema: *428 + schema: *445 examples: - default: *762 + default: *781 '404': description: Not Found if project is not managed by this team x-github: @@ -112335,8 +114023,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: - - *754 - - *429 + - *773 + - *446 requestBody: required: false content: @@ -112403,8 +114091,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: - - *754 - - *429 + - *773 + - *446 responses: '204': description: Response @@ -112431,7 +114119,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *754 + - *773 - *17 - *19 responses: @@ -112441,9 +114129,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 '404': *6 @@ -112473,15 +114161,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: - - *754 - - *430 - - *431 + - *773 + - *447 + - *448 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *763 + schema: *782 examples: alternative-response-with-extra-repository-information: value: @@ -112632,9 +114320,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: - - *754 - - *430 - - *431 + - *773 + - *447 + - *448 requestBody: required: false content: @@ -112684,9 +114372,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: - - *754 - - *430 - - *431 + - *773 + - *447 + - *448 responses: '204': description: Response @@ -112715,15 +114403,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: - - *754 + - *773 responses: '200': description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *433 + default: *450 '403': *27 '404': *6 x-github: @@ -112750,7 +114438,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: - - *754 + - *773 requestBody: required: true content: @@ -112811,7 +114499,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: default: value: @@ -112842,7 +114530,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *754 + - *773 - *17 - *19 responses: @@ -112852,9 +114540,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - response-if-child-teams-exist: *764 + response-if-child-teams-exist: *783 headers: Link: *41 '404': *6 @@ -112887,7 +114575,7 @@ paths: application/json: schema: oneOf: - - &766 + - &785 title: Private User description: Private User type: object @@ -113137,7 +114825,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *765 + - *784 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -113297,7 +114985,7 @@ paths: description: Response content: application/json: - schema: *766 + schema: *785 examples: default: value: @@ -113376,7 +115064,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 '304': *35 '404': *6 '403': *27 @@ -113399,7 +115087,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: - - *178 + - *194 responses: '204': description: If the user is blocked @@ -113427,7 +115115,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *178 + - *194 responses: '204': description: Response @@ -113451,7 +115139,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *178 + - *194 responses: '204': description: Response @@ -113500,9 +115188,9 @@ paths: type: integer codespaces: type: array - items: *336 + items: *354 examples: - default: *337 + default: *355 '304': *35 '500': *38 '401': *23 @@ -113641,21 +115329,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '401': *23 '403': *27 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113695,7 +115383,7 @@ paths: type: integer secrets: type: array - items: &767 + items: &786 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -113737,7 +115425,7 @@ paths: - visibility - selected_repositories_url examples: - default: *538 + default: *555 headers: Link: *41 x-github: @@ -113809,13 +115497,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: - - *256 + - *276 responses: '200': description: Response content: application/json: - schema: *767 + schema: *786 examples: default: value: @@ -113845,7 +115533,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: - - *256 + - *276 requestBody: required: true content: @@ -113890,7 +115578,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -113918,7 +115606,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: - - *256 + - *276 responses: '204': description: Response @@ -113943,7 +115631,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: - - *256 + - *276 responses: '200': description: Response @@ -113959,9 +115647,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: *768 + default: *787 '401': *23 '403': *27 '404': *6 @@ -113986,7 +115674,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: - - *256 + - *276 requestBody: required: true content: @@ -114040,7 +115728,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: - - *256 + - *276 - name: repository_id in: path required: true @@ -114073,7 +115761,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: - - *256 + - *276 - name: repository_id in: path required: true @@ -114105,15 +115793,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: - - *338 + - *356 responses: '200': description: Response content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '304': *35 '500': *38 '401': *23 @@ -114139,7 +115827,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: - - *338 + - *356 requestBody: required: false content: @@ -114169,9 +115857,9 @@ paths: description: Response content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '401': *23 '403': *27 '404': *6 @@ -114193,7 +115881,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: - - *338 + - *356 responses: '202': *37 '304': *35 @@ -114222,13 +115910,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: - - *338 + - *356 responses: '202': description: Response content: application/json: - schema: &769 + schema: &788 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -114281,7 +115969,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &770 + default: &789 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -114313,7 +116001,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *338 + - *356 - name: export_id in: path required: true @@ -114326,9 +116014,9 @@ paths: description: Response content: application/json: - schema: *769 + schema: *788 examples: - default: *770 + default: *789 '404': *6 x-github: githubCloudOnly: false @@ -114349,7 +116037,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *338 + - *356 responses: '200': description: Response @@ -114365,9 +116053,9 @@ paths: type: integer machines: type: array - items: *537 + items: *554 examples: - default: *771 + default: *790 '304': *35 '500': *38 '401': *23 @@ -114396,7 +116084,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: - - *338 + - *356 requestBody: required: true content: @@ -114452,11 +116140,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *443 + repository: *460 machine: anyOf: - type: 'null' - - *537 + - *554 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -115253,15 +116941,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: - - *338 + - *356 responses: '200': description: Response content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '304': *35 '500': *38 '400': *14 @@ -115273,7 +116961,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -115293,15 +116981,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: - - *338 + - *356 responses: '200': description: Response content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '500': *38 '401': *23 '403': *27 @@ -115331,9 +117019,9 @@ paths: application/json: schema: type: array - items: *346 + items: *364 examples: - default: &783 + default: &801 value: - id: 197 name: hello_docker @@ -115434,7 +117122,7 @@ paths: application/json: schema: type: array - items: &772 + items: &791 title: Email description: Email type: object @@ -115504,9 +117192,9 @@ paths: application/json: schema: type: array - items: *772 + items: *791 examples: - default: &785 + default: &803 value: - email: octocat@github.com verified: true @@ -115583,7 +117271,7 @@ paths: application/json: schema: type: array - items: *772 + items: *791 examples: default: value: @@ -115695,7 +117383,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '304': *35 @@ -115728,7 +117416,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '304': *35 @@ -115750,7 +117438,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: - - *178 + - *194 responses: '204': description: if the person is followed by the authenticated user @@ -115780,7 +117468,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *178 + - *194 responses: '204': description: Response @@ -115805,7 +117493,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *178 + - *194 responses: '204': description: Response @@ -115841,7 +117529,7 @@ paths: application/json: schema: type: array - items: &773 + items: &792 title: GPG Key description: A unique encryption key type: object @@ -115986,7 +117674,7 @@ paths: - subkeys - revoked examples: - default: &799 + default: &817 value: - id: 3 name: Octocat's GPG Key @@ -116071,9 +117759,9 @@ paths: description: Response content: application/json: - schema: *773 + schema: *792 examples: - default: &774 + default: &793 value: id: 3 name: Octocat's GPG Key @@ -116130,7 +117818,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: - - &775 + - &794 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -116142,9 +117830,9 @@ paths: description: Response content: application/json: - schema: *773 + schema: *792 examples: - default: *774 + default: *793 '404': *6 '304': *35 '403': *27 @@ -116167,7 +117855,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: - - *775 + - *794 responses: '204': description: Response @@ -116356,9 +118044,9 @@ paths: type: string repositories: type: array - items: *67 + items: *72 examples: - default: *241 + default: *261 headers: Link: *41 '404': *6 @@ -116383,7 +118071,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *240 + - *260 responses: '204': description: Response @@ -116409,7 +118097,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *240 + - *260 responses: '204': description: Response @@ -116443,12 +118131,12 @@ paths: application/json: schema: anyOf: - - *326 + - *344 - type: object properties: {} additionalProperties: false examples: - default: *327 + default: *345 '204': description: Response when there are no restrictions x-github: @@ -116472,7 +118160,7 @@ paths: required: true content: application/json: - schema: *614 + schema: *631 examples: default: value: @@ -116483,7 +118171,7 @@ paths: description: Response content: application/json: - schema: *326 + schema: *344 examples: default: value: @@ -116564,7 +118252,7 @@ paths: - closed - all default: open - - *334 + - *352 - name: sort description: What to sort results by. in: query @@ -116576,8 +118264,8 @@ paths: - updated - comments default: created - - *99 - - *189 + - *104 + - *206 - *17 - *19 responses: @@ -116587,9 +118275,9 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: *335 + default: *353 headers: Link: *41 '404': *6 @@ -116622,7 +118310,7 @@ paths: application/json: schema: type: array - items: &776 + items: &795 title: Key description: Key type: object @@ -116725,9 +118413,9 @@ paths: description: Response content: application/json: - schema: *776 + schema: *795 examples: - default: &777 + default: &796 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -116760,15 +118448,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: - - *640 + - *657 responses: '200': description: Response content: application/json: - schema: *776 + schema: *795 examples: - default: *777 + default: *796 '404': *6 '304': *35 '403': *27 @@ -116791,7 +118479,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: - - *640 + - *657 responses: '204': description: Response @@ -116824,7 +118512,7 @@ paths: application/json: schema: type: array - items: &778 + items: &797 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -116892,7 +118580,7 @@ paths: - id - type - login - plan: *200 + plan: *217 required: - billing_cycle - next_billing_date @@ -116903,7 +118591,7 @@ paths: - account - plan examples: - default: &779 + default: &798 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -116965,9 +118653,9 @@ paths: application/json: schema: type: array - items: *778 + items: *797 examples: - default: *779 + default: *798 headers: Link: *41 '304': *35 @@ -117007,7 +118695,7 @@ paths: application/json: schema: type: array - items: *339 + items: *357 examples: default: value: @@ -117109,13 +118797,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *339 + schema: *357 examples: default: value: @@ -117173,7 +118861,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: - - *76 + - *81 requestBody: required: true content: @@ -117198,7 +118886,7 @@ paths: description: Response content: application/json: - schema: *339 + schema: *357 examples: default: value: @@ -117266,7 +118954,7 @@ paths: application/json: schema: type: array - items: *341 + items: *359 examples: default: value: @@ -117528,7 +119216,7 @@ paths: description: Response content: application/json: - schema: *341 + schema: *359 examples: default: value: @@ -117708,7 +119396,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *342 + - *360 - name: exclude in: query required: false @@ -117721,7 +119409,7 @@ paths: description: Response content: application/json: - schema: *341 + schema: *359 examples: default: value: @@ -117915,7 +119603,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *342 + - *360 responses: '302': description: Response @@ -117941,7 +119629,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *342 + - *360 responses: '204': description: Response @@ -117970,8 +119658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *342 - - *780 + - *360 + - *799 responses: '204': description: Response @@ -117995,7 +119683,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *342 + - *360 - *17 - *19 responses: @@ -118005,9 +119693,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 '404': *6 @@ -118042,9 +119730,9 @@ paths: application/json: schema: type: array - items: *62 + items: *67 examples: - default: *781 + default: *230 headers: Link: *41 '304': *35 @@ -118086,7 +119774,7 @@ paths: - docker - nuget - container - - *782 + - *800 - *19 - *17 responses: @@ -118096,10 +119784,10 @@ paths: application/json: schema: type: array - items: *346 + items: *364 examples: - default: *783 - '400': *784 + default: *801 + '400': *802 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118119,16 +119807,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: - - *348 - - *349 + - *366 + - *367 responses: '200': description: Response content: application/json: - schema: *346 + schema: *364 examples: - default: &800 + default: &818 value: id: 40201 name: octo-name @@ -118241,8 +119929,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: - - *348 - - *349 + - *366 + - *367 responses: '204': description: Response @@ -118272,8 +119960,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: - - *348 - - *349 + - *366 + - *367 - name: token description: package token schema: @@ -118305,8 +119993,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: - - *348 - - *349 + - *366 + - *367 - *19 - *17 - name: state @@ -118326,7 +120014,7 @@ paths: application/json: schema: type: array - items: *350 + items: *368 examples: default: value: @@ -118375,15 +120063,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: - - *348 - - *349 - - *351 + - *366 + - *367 + - *369 responses: '200': description: Response content: application/json: - schema: *350 + schema: *368 examples: default: value: @@ -118419,9 +120107,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: - - *348 - - *349 - - *351 + - *366 + - *367 + - *369 responses: '204': description: Response @@ -118451,9 +120139,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: - - *348 - - *349 - - *351 + - *366 + - *367 + - *369 responses: '204': description: Response @@ -118511,7 +120199,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *380 examples: default: value: @@ -118583,9 +120271,9 @@ paths: application/json: schema: type: array - items: *772 + items: *791 examples: - default: *785 + default: *803 headers: Link: *41 '304': *35 @@ -118696,9 +120384,9 @@ paths: application/json: schema: type: array - items: *67 + items: *72 examples: - default: &792 + default: &810 summary: Default response value: - id: 1296269 @@ -119016,9 +120704,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - default: *445 + default: *462 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -119056,9 +120744,9 @@ paths: application/json: schema: type: array - items: *616 + items: *633 examples: - default: *786 + default: *804 headers: Link: *41 '304': *35 @@ -119081,12 +120769,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *330 + - *348 responses: '204': description: Response '403': *27 - '409': *107 + '409': *112 '404': *6 '304': *35 x-github: @@ -119104,11 +120792,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *330 + - *348 responses: '204': description: Response - '409': *107 + '409': *112 '304': *35 '404': *6 '403': *27 @@ -119137,7 +120825,7 @@ paths: application/json: schema: type: array - items: &787 + items: &805 title: Social account description: Social media account type: object @@ -119154,7 +120842,7 @@ paths: - provider - url examples: - default: &788 + default: &806 value: - provider: twitter url: https://twitter.com/github @@ -119217,9 +120905,9 @@ paths: application/json: schema: type: array - items: *787 + items: *805 examples: - default: *788 + default: *806 '422': *15 '304': *35 '404': *6 @@ -119307,7 +120995,7 @@ paths: application/json: schema: type: array - items: &789 + items: &807 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -119327,7 +121015,7 @@ paths: - title - created_at examples: - default: &803 + default: &821 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -119394,9 +121082,9 @@ paths: description: Response content: application/json: - schema: *789 + schema: *807 examples: - default: &790 + default: &808 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -119427,7 +121115,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: - - &791 + - &809 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -119439,9 +121127,9 @@ paths: description: Response content: application/json: - schema: *789 + schema: *807 examples: - default: *790 + default: *808 '404': *6 '304': *35 '403': *27 @@ -119464,7 +121152,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: - - *791 + - *809 responses: '204': description: Response @@ -119493,7 +121181,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: - - &804 + - &822 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 @@ -119506,7 +121194,7 @@ paths: - created - updated default: created - - *99 + - *104 - *17 - *19 responses: @@ -119516,13 +121204,13 @@ paths: application/json: schema: type: array - items: *67 + items: *72 examples: - default-response: *792 + default-response: *810 application/vnd.github.v3.star+json: schema: type: array - items: &805 + items: &823 title: Starred Repository description: Starred Repository type: object @@ -119530,7 +121218,7 @@ paths: starred_at: type: string format: date-time - repo: *67 + repo: *72 required: - starred_at - repo @@ -119678,8 +121366,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response if this repository is starred by you @@ -119707,8 +121395,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -119732,8 +121420,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -119766,9 +121454,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 '304': *35 @@ -119805,7 +121493,7 @@ paths: application/json: schema: type: array - items: *411 + items: *428 examples: default: value: @@ -119883,7 +121571,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *202 + - *219 responses: '200': description: Response @@ -119891,10 +121579,10 @@ paths: application/json: schema: oneOf: - - *766 - - *765 + - *785 + - *784 examples: - default-response: &794 + default-response: &812 summary: Default response value: login: octocat @@ -119929,7 +121617,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &795 + response-with-git-hub-plan-information: &813 summary: Response with GitHub plan information value: login: octocat @@ -119989,7 +121677,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *793 + - *811 - *17 responses: '200': @@ -120000,7 +121688,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: example: ; rel="next" @@ -120030,7 +121718,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *178 + - *194 responses: '200': description: Response @@ -120038,11 +121726,11 @@ paths: application/json: schema: oneOf: - - *766 - - *765 + - *785 + - *784 examples: - default-response: *794 - response-with-git-hub-plan-information: *795 + default-response: *812 + response-with-git-hub-plan-information: *813 '404': *6 x-github: githubCloudOnly: false @@ -120066,9 +121754,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *97 - - *98 - - *178 + - *102 + - *103 + - *194 requestBody: required: true content: @@ -120091,8 +121779,8 @@ paths: required: - subject_digests examples: - default: *796 - withPredicateType: *797 + default: *814 + withPredicateType: *815 responses: '200': description: Response @@ -120146,7 +121834,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *798 + default: *816 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -120164,7 +121852,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk parameters: - - *178 + - *194 requestBody: required: true content: @@ -120229,7 +121917,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *178 + - *194 - name: subject_digest description: Subject Digest in: path @@ -120260,7 +121948,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id parameters: - - *178 + - *194 - name: attestation_id description: Attestation ID in: path @@ -120296,9 +121984,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations parameters: - *17 - - *97 - - *98 - - *178 + - *102 + - *103 + - *194 - name: subject_digest description: Subject Digest in: path @@ -120350,12 +122038,12 @@ paths: initiator: type: string examples: - default: *483 + default: *500 '201': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -120381,7 +122069,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: - - *178 + - *194 responses: '200': description: Response @@ -120389,9 +122077,9 @@ paths: application/json: schema: type: array - items: *346 + items: *364 examples: - default: *783 + default: *801 '403': *27 '401': *23 x-github: @@ -120414,7 +122102,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120424,7 +122112,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -120486,8 +122174,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: - - *178 - - *76 + - *194 + - *81 - *17 - *19 responses: @@ -120497,7 +122185,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -120574,7 +122262,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120584,7 +122272,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -120642,7 +122330,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120654,7 +122342,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -120673,7 +122361,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120685,7 +122373,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -120704,7 +122392,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: - - *178 + - *194 - name: target_user in: path required: true @@ -120731,8 +122419,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *178 - - *189 + - *194 + - *206 - *17 - *19 responses: @@ -120742,9 +122430,9 @@ paths: application/json: schema: type: array - items: *190 + items: *207 examples: - default: *191 + default: *208 headers: Link: *41 '422': *15 @@ -120765,7 +122453,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: - - *178 + - *194 - *17 - *19 responses: @@ -120775,9 +122463,9 @@ paths: application/json: schema: type: array - items: *773 + items: *792 examples: - default: *799 + default: *817 headers: Link: *41 x-github: @@ -120801,7 +122489,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *178 + - *194 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -120873,7 +122561,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: - - *178 + - *194 responses: '200': description: Response @@ -120881,7 +122569,7 @@ paths: application/json: schema: *20 examples: - default: *613 + default: *630 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120899,7 +122587,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120955,7 +122643,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120965,9 +122653,9 @@ paths: application/json: schema: type: array - items: *62 + items: *67 examples: - default: *781 + default: *230 headers: Link: *41 x-github: @@ -121006,8 +122694,8 @@ paths: - docker - nuget - container - - *782 - - *178 + - *800 + - *194 - *19 - *17 responses: @@ -121017,12 +122705,12 @@ paths: application/json: schema: type: array - items: *346 + items: *364 examples: - default: *783 + default: *801 '403': *27 '401': *23 - '400': *784 + '400': *802 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121042,17 +122730,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *348 - - *349 - - *178 + - *366 + - *367 + - *194 responses: '200': description: Response content: application/json: - schema: *346 + schema: *364 examples: - default: *800 + default: *818 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121073,9 +122761,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *348 - - *349 - - *178 + - *366 + - *367 + - *194 responses: '204': description: Response @@ -121107,9 +122795,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *348 - - *349 - - *178 + - *366 + - *367 + - *194 - name: token description: package token schema: @@ -121141,9 +122829,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: - - *348 - - *349 - - *178 + - *366 + - *367 + - *194 responses: '200': description: Response @@ -121151,7 +122839,7 @@ paths: application/json: schema: type: array - items: *350 + items: *368 examples: default: value: @@ -121209,16 +122897,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: - - *348 - - *349 - - *351 - - *178 + - *366 + - *367 + - *369 + - *194 responses: '200': description: Response content: application/json: - schema: *350 + schema: *368 examples: default: value: @@ -121253,10 +122941,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *348 - - *349 - - *178 - - *351 + - *366 + - *367 + - *194 + - *369 responses: '204': description: Response @@ -121288,10 +122976,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *348 - - *349 - - *178 - - *351 + - *366 + - *367 + - *194 + - *369 responses: '204': description: Response @@ -121317,7 +123005,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects parameters: - - *178 + - *194 - name: state description: Indicates the state of the projects to return. in: query @@ -121338,7 +123026,7 @@ paths: application/json: schema: type: array - items: *362 + items: *380 examples: default: value: @@ -121396,15 +123084,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user parameters: - - *178 + - *194 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *97 - - *98 + - *102 + - *103 - *17 responses: '200': @@ -121413,9 +123101,9 @@ paths: application/json: schema: type: array - items: *363 + items: *381 examples: - default: *364 + default: *382 headers: Link: *41 '304': *35 @@ -121437,16 +123125,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *365 - - *178 + - *383 + - *194 responses: '200': description: Response content: application/json: - schema: *363 + schema: *381 examples: - default: *364 + default: *382 headers: Link: *41 '304': *35 @@ -121468,11 +123156,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *365 - - *178 + - *383 + - *194 - *17 - - *97 - - *98 + - *102 + - *103 responses: '200': description: Response @@ -121480,9 +123168,9 @@ paths: application/json: schema: type: array - items: *366 + items: *384 examples: - default: *367 + default: *385 headers: Link: *41 '304': *35 @@ -121504,17 +123192,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *365 - - *801 - - *178 + - *383 + - *819 + - *194 responses: '200': description: Response content: application/json: - schema: *366 + schema: *384 examples: - default: *367 + default: *385 headers: Link: *41 '304': *35 @@ -121537,10 +123225,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: - - *365 - - *178 - - *97 - - *98 + - *383 + - *194 + - *102 + - *103 - *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) @@ -121550,17 +123238,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -121568,9 +123258,9 @@ paths: application/json: schema: type: array - items: *372 + items: *390 examples: - default: *373 + default: *391 headers: Link: *41 '304': *35 @@ -121591,8 +123281,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - - *178 - - *365 + - *194 + - *383 requestBody: required: true description: Details of the item to add to the project. @@ -121629,10 +123319,10 @@ paths: description: Response content: application/json: - schema: *802 + schema: *820 examples: - issue: *371 - pull_request: *371 + issue: *389 + pull_request: *389 '304': *35 '403': *27 '401': *23 @@ -121652,29 +123342,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: - - *365 - - *178 - - *374 + - *383 + - *194 + - *392 - 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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *372 + schema: *390 examples: - default: *373 + default: *391 headers: Link: *41 '304': *35 @@ -121695,9 +123387,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *365 - - *178 - - *374 + - *383 + - *194 + - *392 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -121770,13 +123462,13 @@ paths: description: Response content: application/json: - schema: *372 + schema: *390 examples: - text_field: *373 - number_field: *373 - date_field: *373 - single_select_field: *373 - iteration_field: *373 + text_field: *391 + number_field: *391 + date_field: *391 + single_select_field: *391 + iteration_field: *391 '401': *23 '403': *27 '404': *6 @@ -121796,9 +123488,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *365 - - *178 - - *374 + - *383 + - *194 + - *392 responses: '204': description: Response @@ -121825,7 +123517,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: - - *178 + - *194 - *17 - *19 responses: @@ -121835,7 +123527,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -121900,7 +123592,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: - - *178 + - *194 - *17 - *19 responses: @@ -121910,7 +123602,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -121973,7 +123665,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *178 + - *194 - name: type description: Limit results to repositories of the specified type. in: query @@ -122016,9 +123708,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -122042,15 +123734,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: - - *178 + - *194 responses: '200': description: Response content: application/json: - schema: *398 + schema: *415 examples: - default: *399 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122072,15 +123764,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: - - *178 + - *194 responses: '200': description: Response content: application/json: - schema: *403 + schema: *420 examples: - default: *404 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122089,7 +123781,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 @@ -122097,12 +123792,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: - - *178 - - *169 - - *213 - - *170 - - *215 - - *216 + - *194 + - *185 + - *231 + - *186 + - *233 + - *234 responses: '200': description: Response when getting a billing premium request usage report @@ -122155,19 +123850,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 @@ -122210,7 +123905,7 @@ paths: '403': *27 '404': *6 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -122232,15 +123927,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: - - *178 + - *194 responses: '200': description: Response content: application/json: - schema: *405 + schema: *422 examples: - default: *406 + default: *423 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122260,11 +123955,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: - - *178 - - *169 - - *217 - - *170 - - *218 + - *194 + - *185 + - *235 + - *186 + - *236 responses: '200': description: Response when getting a billing usage report @@ -122335,7 +124030,7 @@ paths: '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -122353,7 +124048,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: - - *178 + - *194 - *17 - *19 responses: @@ -122363,9 +124058,9 @@ paths: application/json: schema: type: array - items: *787 + items: *805 examples: - default: *788 + default: *806 headers: Link: *41 x-github: @@ -122385,7 +124080,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: - - *178 + - *194 - *17 - *19 responses: @@ -122395,9 +124090,9 @@ paths: application/json: schema: type: array - items: *789 + items: *807 examples: - default: *803 + default: *821 headers: Link: *41 x-github: @@ -122421,9 +124116,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *178 - - *804 - - *99 + - *194 + - *822 + - *104 - *17 - *19 responses: @@ -122434,11 +124129,11 @@ paths: schema: anyOf: - type: array - items: *805 + items: *823 - type: array - items: *67 + items: *72 examples: - default-response: *792 + default-response: *810 headers: Link: *41 x-github: @@ -122457,7 +124152,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -122467,9 +124162,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -122598,7 +124293,7 @@ webhooks: type: string enum: - disabled - enterprise: &806 + enterprise: &824 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -122667,7 +124362,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &807 + installation: &825 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -122688,7 +124383,7 @@ webhooks: required: - id - node_id - organization: &808 + organization: &826 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -122761,7 +124456,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &809 + repository: &827 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -122790,7 +124485,7 @@ webhooks: license: anyOf: - type: 'null' - - *186 + - *203 organization: anyOf: - type: 'null' @@ -123674,10 +125369,10 @@ webhooks: type: string enum: - enabled - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -123753,11 +125448,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - rule: &810 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + rule: &828 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) @@ -123980,11 +125675,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - rule: *810 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + rule: *828 sender: *4 required: - action @@ -124172,11 +125867,11 @@ webhooks: - everyone required: - from - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - rule: *810 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + rule: *828 sender: *4 required: - action @@ -124247,7 +125942,7 @@ webhooks: required: true content: application/json: - schema: &813 + schema: &831 title: Exemption request cancellation event type: object properties: @@ -124255,11 +125950,11 @@ webhooks: type: string enum: - cancelled - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - exemption_request: &811 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + exemption_request: &829 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -124497,7 +126192,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &812 + items: &830 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -124607,7 +126302,7 @@ webhooks: required: true content: application/json: - schema: &814 + schema: &832 title: Exemption request completed event type: object properties: @@ -124615,11 +126310,11 @@ webhooks: type: string enum: - completed - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - exemption_request: *811 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + exemption_request: *829 sender: *4 required: - action @@ -124689,7 +126384,7 @@ webhooks: required: true content: application/json: - schema: &815 + schema: &833 title: Exemption request created event type: object properties: @@ -124697,11 +126392,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - exemption_request: *811 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + exemption_request: *829 sender: *4 required: - action @@ -124771,7 +126466,7 @@ webhooks: required: true content: application/json: - schema: &816 + schema: &834 title: Exemption response dismissed event type: object properties: @@ -124779,12 +126474,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - exemption_request: *811 - exemption_response: *812 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + exemption_request: *829 + exemption_response: *830 sender: *4 required: - action @@ -124856,7 +126551,7 @@ webhooks: required: true content: application/json: - schema: &817 + schema: &835 title: Exemption response submitted event type: object properties: @@ -124864,12 +126559,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - exemption_request: *811 - exemption_response: *812 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + exemption_request: *829 + exemption_response: *830 sender: *4 required: - action @@ -124942,7 +126637,7 @@ webhooks: required: true content: application/json: - schema: *813 + schema: *831 responses: '200': description: Return a 200 status to indicate that the data was received @@ -125009,7 +126704,7 @@ webhooks: required: true content: application/json: - schema: *814 + schema: *832 responses: '200': description: Return a 200 status to indicate that the data was received @@ -125076,7 +126771,7 @@ webhooks: required: true content: application/json: - schema: *815 + schema: *833 responses: '200': description: Return a 200 status to indicate that the data was received @@ -125143,7 +126838,7 @@ webhooks: required: true content: application/json: - schema: *816 + schema: *834 responses: '200': description: Return a 200 status to indicate that the data was received @@ -125211,7 +126906,7 @@ webhooks: required: true content: application/json: - schema: *817 + schema: *835 responses: '200': description: Return a 200 status to indicate that the data was received @@ -125289,7 +126984,7 @@ webhooks: type: string enum: - completed - check_run: &819 + check_run: &837 title: CheckRun description: A check performed on the code of a given code change type: object @@ -125354,8 +127049,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *187 - repository: *246 + items: *204 + repository: *266 status: type: string enum: @@ -125399,7 +127094,7 @@ webhooks: - examples: - neutral - deployment: *818 + deployment: *836 details_url: type: string examples: @@ -125459,7 +127154,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *187 + items: *204 started_at: type: string format: date-time @@ -125497,10 +127192,10 @@ webhooks: - output - app - pull_requests - installation: *807 - enterprise: *806 - organization: *808 - repository: *809 + installation: *825 + enterprise: *824 + organization: *826 + repository: *827 sender: *4 required: - check_run @@ -125893,11 +127588,11 @@ webhooks: type: string enum: - created - check_run: *819 - installation: *807 - enterprise: *806 - organization: *808 - repository: *809 + check_run: *837 + installation: *825 + enterprise: *824 + organization: *826 + repository: *827 sender: *4 required: - check_run @@ -126293,11 +127988,11 @@ webhooks: type: string enum: - requested_action - check_run: *819 - installation: *807 - enterprise: *806 - organization: *808 - repository: *809 + check_run: *837 + installation: *825 + enterprise: *824 + organization: *826 + repository: *827 requested_action: description: The action requested by the user. type: object @@ -126702,11 +128397,11 @@ webhooks: type: string enum: - rerequested - check_run: *819 - installation: *807 - enterprise: *806 - organization: *808 - repository: *809 + check_run: *837 + installation: *825 + enterprise: *824 + organization: *826 + repository: *827 sender: *4 required: - check_run @@ -127698,10 +129393,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -128386,10 +130081,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -129068,10 +130763,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -129240,7 +130935,7 @@ webhooks: required: - login - id - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -129392,20 +131087,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &820 + commit_oid: &838 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: *806 - installation: *807 - organization: *808 - ref: &821 + enterprise: *824 + installation: *825 + organization: *826 + ref: &839 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: *809 + repository: *827 sender: *4 required: - action @@ -129572,7 +131267,7 @@ webhooks: required: - login - id - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -129813,12 +131508,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *820 - enterprise: *806 - installation: *807 - organization: *808 - ref: *821 - repository: *809 + commit_oid: *838 + enterprise: *824 + installation: *825 + organization: *826 + ref: *839 + repository: *827 sender: *4 required: - action @@ -129916,7 +131611,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -130101,12 +131796,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *820 - enterprise: *806 - installation: *807 - organization: *808 - ref: *821 - repository: *809 + commit_oid: *838 + enterprise: *824 + installation: *825 + organization: *826 + ref: *839 + repository: *827 sender: *4 required: - action @@ -130275,7 +131970,7 @@ webhooks: required: - login - id - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -130452,12 +132147,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *820 - enterprise: *806 - installation: *807 - organization: *808 - ref: *821 - repository: *809 + commit_oid: *838 + enterprise: *824 + installation: *825 + organization: *826 + ref: *839 + repository: *827 sender: *4 required: - action @@ -130560,7 +132255,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -130740,9 +132435,9 @@ webhooks: type: - string - 'null' - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -130750,7 +132445,7 @@ webhooks: type: - string - 'null' - repository: *809 + repository: *827 sender: *4 required: - action @@ -130849,7 +132544,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -130996,12 +132691,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *820 - enterprise: *806 - installation: *807 - organization: *808 - ref: *821 - repository: *809 + commit_oid: *838 + enterprise: *824 + installation: *825 + organization: *826 + ref: *839 + repository: *827 sender: *4 required: - action @@ -131263,10 +132958,10 @@ webhooks: - updated_at - author_association - body - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -131347,18 +133042,18 @@ webhooks: type: - string - 'null' - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *808 - pusher_type: &822 + organization: *826 + pusher_type: &840 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &823 + ref: &841 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -131368,7 +133063,7 @@ webhooks: enum: - tag - branch - repository: *809 + repository: *827 sender: *4 required: - ref @@ -131450,10 +133145,10 @@ webhooks: type: string enum: - created - definition: *125 - enterprise: *806 - installation: *807 - organization: *808 + definition: *141 + enterprise: *824 + installation: *825 + organization: *826 sender: *4 required: - action @@ -131538,9 +133233,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 sender: *4 required: - action @@ -131617,10 +133312,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *125 - enterprise: *806 - installation: *807 - organization: *808 + definition: *141 + enterprise: *824 + installation: *825 + organization: *826 sender: *4 required: - action @@ -131697,10 +133392,10 @@ webhooks: type: string enum: - updated - definition: *125 - enterprise: *806 - installation: *807 - organization: *808 + definition: *141 + enterprise: *824 + installation: *825 + organization: *826 sender: *4 required: - action @@ -131777,19 +133472,19 @@ webhooks: type: string enum: - updated - enterprise: *806 - installation: *807 - repository: *809 - organization: *808 + enterprise: *824 + installation: *825 + repository: *827 + organization: *826 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *376 + items: *140 old_property_values: type: array description: The old custom property values for the repository. - items: *376 + items: *140 required: - action - repository @@ -131865,18 +133560,18 @@ webhooks: title: delete event type: object properties: - enterprise: *806 - installation: *807 - organization: *808 - pusher_type: *822 - ref: *823 + enterprise: *824 + installation: *825 + organization: *826 + pusher_type: *840 + ref: *841 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *809 + repository: *827 sender: *4 required: - ref @@ -131960,11 +133655,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132048,11 +133743,11 @@ webhooks: type: string enum: - auto_reopened - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132136,11 +133831,11 @@ webhooks: type: string enum: - created - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132222,11 +133917,11 @@ webhooks: type: string enum: - dismissed - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132308,11 +134003,11 @@ webhooks: type: string enum: - fixed - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132395,11 +134090,11 @@ webhooks: type: string enum: - reintroduced - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132481,11 +134176,11 @@ webhooks: type: string enum: - reopened - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132562,9 +134257,9 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - key: &824 + enterprise: *824 + installation: *825 + key: &842 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -132602,8 +134297,8 @@ webhooks: - verified - created_at - read_only - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -132680,11 +134375,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - key: *824 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + key: *842 + organization: *826 + repository: *827 sender: *4 required: - action @@ -133256,12 +134951,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - workflow: &828 + workflow: &846 title: Workflow type: - object @@ -133999,13 +135694,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *569 + deployment: *586 pull_requests: type: array - items: *658 - repository: *809 - organization: *808 - installation: *807 + items: *677 + repository: *827 + organization: *826 + installation: *825 sender: *4 responses: '200': @@ -134076,7 +135771,7 @@ webhooks: type: string enum: - approved - approver: &825 + approver: &843 type: object properties: avatar_url: @@ -134119,11 +135814,11 @@ webhooks: type: string comment: type: string - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - reviewers: &826 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + reviewers: &844 type: array items: type: object @@ -134204,7 +135899,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &827 + workflow_job_run: &845 type: object properties: conclusion: @@ -134950,18 +136645,18 @@ webhooks: type: string enum: - rejected - approver: *825 + approver: *843 comment: type: string - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - reviewers: *826 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + reviewers: *844 sender: *4 since: type: string - workflow_job_run: *827 + workflow_job_run: *845 workflow_job_runs: type: array items: @@ -135678,13 +137373,13 @@ webhooks: type: string enum: - requested - enterprise: *806 + enterprise: *824 environment: type: string - installation: *807 - organization: *808 - repository: *809 - requestor: &833 + installation: *825 + organization: *826 + repository: *827 + requestor: &851 title: User type: - object @@ -137627,12 +139322,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - workflow: *828 + workflow: *846 workflow_run: title: Deployment Workflow Run type: @@ -138323,7 +140018,7 @@ webhooks: type: string enum: - answered - answer: &831 + answer: &849 type: object properties: author_association: @@ -138483,11 +140178,11 @@ webhooks: - created_at - updated_at - body - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -138614,11 +140309,11 @@ webhooks: - from required: - category - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -138701,11 +140396,11 @@ webhooks: type: string enum: - closed - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -138787,7 +140482,7 @@ webhooks: type: string enum: - created - comment: &830 + comment: &848 type: object properties: author_association: @@ -138947,11 +140642,11 @@ webhooks: - updated_at - body - reactions - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139034,12 +140729,12 @@ webhooks: type: string enum: - deleted - comment: *830 - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + comment: *848 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139134,12 +140829,12 @@ webhooks: - from required: - body - comment: *830 - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + comment: *848 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139223,11 +140918,11 @@ webhooks: type: string enum: - created - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139309,11 +141004,11 @@ webhooks: type: string enum: - deleted - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139413,11 +141108,11 @@ webhooks: type: string required: - from - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139499,10 +141194,10 @@ webhooks: type: string enum: - labeled - discussion: *829 - enterprise: *806 - installation: *807 - label: &832 + discussion: *847 + enterprise: *824 + installation: *825 + label: &850 title: Label type: object properties: @@ -139535,8 +141230,8 @@ webhooks: - color - default - description - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139619,11 +141314,11 @@ webhooks: type: string enum: - locked - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139705,11 +141400,11 @@ webhooks: type: string enum: - pinned - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139791,11 +141486,11 @@ webhooks: type: string enum: - reopened - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139880,16 +141575,16 @@ webhooks: changes: type: object properties: - new_discussion: *829 - new_repository: *809 + new_discussion: *847 + new_repository: *827 required: - new_discussion - new_repository - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139972,10 +141667,10 @@ webhooks: type: string enum: - unanswered - discussion: *829 - old_answer: *831 - organization: *808 - repository: *809 + discussion: *847 + old_answer: *849 + organization: *826 + repository: *827 sender: *4 required: - action @@ -140057,12 +141752,12 @@ webhooks: type: string enum: - unlabeled - discussion: *829 - enterprise: *806 - installation: *807 - label: *832 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -140145,11 +141840,11 @@ webhooks: type: string enum: - unlocked - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -140231,11 +141926,11 @@ webhooks: type: string enum: - unpinned - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -140304,7 +141999,7 @@ webhooks: required: true content: application/json: - schema: *815 + schema: *833 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140367,7 +142062,7 @@ webhooks: required: true content: application/json: - schema: *817 + schema: *835 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140433,7 +142128,7 @@ webhooks: required: true content: application/json: - schema: *813 + schema: *831 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140499,7 +142194,7 @@ webhooks: required: true content: application/json: - schema: *814 + schema: *832 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140565,7 +142260,7 @@ webhooks: required: true content: application/json: - schema: *815 + schema: *833 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140631,7 +142326,7 @@ webhooks: required: true content: application/json: - schema: *816 + schema: *834 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140697,7 +142392,7 @@ webhooks: required: true content: application/json: - schema: *817 + schema: *835 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140764,7 +142459,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *806 + enterprise: *824 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -141442,9 +143137,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *807 - organization: *808 - repository: *809 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - forkee @@ -141590,9 +143285,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pages: description: The pages that were updated. type: array @@ -141630,7 +143325,7 @@ webhooks: - action - sha - html_url - repository: *809 + repository: *827 sender: *4 required: - pages @@ -141706,10 +143401,10 @@ webhooks: type: string enum: - created - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories: &834 + organization: *826 + repositories: &852 description: An array of repository objects that the installation can access. type: array @@ -141735,8 +143430,8 @@ webhooks: - name - full_name - private - repository: *809 - requester: *833 + repository: *827 + requester: *851 sender: *4 required: - action @@ -141811,11 +143506,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories: *834 - repository: *809 + organization: *826 + repositories: *852 + repository: *827 requester: type: - 'null' @@ -141892,11 +143587,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories: *834 - repository: *809 + organization: *826 + repositories: *852 + repository: *827 requester: type: - 'null' @@ -141973,10 +143668,10 @@ webhooks: type: string enum: - added - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories_added: &835 + organization: *826 + repositories_added: &853 description: An array of repository objects, which were added to the installation. type: array @@ -142022,15 +143717,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *809 - repository_selection: &836 + repository: *827 + repository_selection: &854 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *833 + requester: *851 sender: *4 required: - action @@ -142109,10 +143804,10 @@ webhooks: type: string enum: - removed - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories_added: *835 + organization: *826 + repositories_added: *853 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -142139,9 +143834,9 @@ webhooks: - name - full_name - private - repository: *809 - repository_selection: *836 - requester: *833 + repository: *827 + repository_selection: *854 + requester: *851 sender: *4 required: - action @@ -142220,11 +143915,11 @@ webhooks: type: string enum: - suspend - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories: *834 - repository: *809 + organization: *826 + repositories: *852 + repository: *827 requester: type: - 'null' @@ -142407,10 +144102,10 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 target_type: type: string @@ -142489,11 +144184,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories: *834 - repository: *809 + organization: *826 + repositories: *852 + repository: *827 requester: type: - 'null' @@ -142741,8 +144436,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -143559,8 +145254,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143577,7 +145272,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -143921,8 +145616,8 @@ webhooks: - state - locked - assignee - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -144002,7 +145697,7 @@ webhooks: type: string enum: - deleted - comment: &837 + comment: &855 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -144169,8 +145864,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -144983,8 +146678,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145001,7 +146696,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -145347,8 +147042,8 @@ webhooks: - state - locked - assignee - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -145428,7 +147123,7 @@ webhooks: type: string enum: - edited - changes: &861 + changes: &879 description: The changes to the comment. type: object properties: @@ -145440,9 +147135,9 @@ webhooks: type: string required: - from - comment: *837 - enterprise: *806 - installation: *807 + comment: *855 + enterprise: *824 + installation: *825 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -146258,8 +147953,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146276,7 +147971,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -146620,8 +148315,8 @@ webhooks: - state - locked - assignee - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -146705,15 +148400,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *183 + blocked_issue: *200 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *183 - blocking_issue_repo: *67 - installation: *807 - organization: *808 - repository: *809 + blocking_issue: *200 + blocking_issue_repo: *72 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -146801,15 +148496,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *183 + blocked_issue: *200 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *183 - blocking_issue_repo: *67 - installation: *807 - organization: *808 - repository: *809 + blocking_issue: *200 + blocking_issue_repo: *72 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -146896,15 +148591,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *183 - blocked_issue_repo: *67 + blocked_issue: *200 + blocked_issue_repo: *72 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *183 - installation: *807 - organization: *808 - repository: *809 + blocking_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -146992,15 +148687,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *183 - blocked_issue_repo: *67 + blocked_issue: *200 + blocked_issue_repo: *72 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *183 - installation: *807 - organization: *808 - repository: *809 + blocking_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -147085,10 +148780,10 @@ webhooks: type: string enum: - assigned - assignee: *833 - enterprise: *806 - installation: *807 - issue: &840 + assignee: *851 + enterprise: *824 + installation: *825 + issue: &858 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -147900,11 +149595,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147921,7 +149616,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -148024,8 +149719,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -148105,8 +149800,8 @@ webhooks: type: string enum: - closed - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -148923,11 +150618,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148944,7 +150639,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -149190,8 +150885,8 @@ webhooks: required: - state - closed_at - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -149270,8 +150965,8 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150079,11 +151774,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150100,7 +151795,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -150202,8 +151897,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -150282,8 +151977,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151114,11 +152809,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151135,7 +152830,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -151216,7 +152911,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &838 + milestone: &856 title: Milestone description: A collection of related issues and pull requests. type: object @@ -151359,8 +153054,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -151459,8 +153154,8 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152272,11 +153967,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152290,7 +153985,7 @@ webhooks: timeline_url: type: string format: uri - type: *331 + type: *349 title: description: Title of the issue type: string @@ -152396,9 +154091,9 @@ webhooks: - active_lock_reason - body - reactions - label: *832 - organization: *808 - repository: *809 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -152478,8 +154173,8 @@ webhooks: type: string enum: - labeled - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153290,11 +154985,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153308,7 +155003,7 @@ webhooks: timeline_url: type: string format: uri - type: *331 + type: *349 title: description: Title of the issue type: string @@ -153414,9 +155109,9 @@ webhooks: - active_lock_reason - body - reactions - label: *832 - organization: *808 - repository: *809 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -153496,8 +155191,8 @@ webhooks: type: string enum: - locked - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -154333,11 +156028,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154351,7 +156046,7 @@ webhooks: timeline_url: type: string format: uri - type: *331 + type: *349 title: description: Title of the issue type: string @@ -154434,8 +156129,8 @@ webhooks: format: uri user_view_type: type: string - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -154514,8 +156209,8 @@ webhooks: type: string enum: - milestoned - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155345,11 +157040,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155366,7 +157061,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -155446,9 +157141,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *838 - organization: *808 - repository: *809 + milestone: *856 + organization: *826 + repository: *827 sender: *4 required: - action @@ -156340,11 +158035,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156440,7 +158135,7 @@ webhooks: required: - login - id - type: *331 + type: *349 required: - id - number @@ -156921,8 +158616,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -157734,11 +159429,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157755,7 +159450,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -157857,8 +159552,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -157938,9 +159633,9 @@ webhooks: type: string enum: - pinned - enterprise: *806 - installation: *807 - issue: &839 + enterprise: *824 + installation: *825 + issue: &857 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -158746,11 +160441,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158767,7 +160462,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -158869,8 +160564,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -158949,8 +160644,8 @@ webhooks: type: string enum: - reopened - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -159784,11 +161479,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159885,9 +161580,9 @@ webhooks: format: uri user_view_type: type: string - type: *331 - organization: *808 - repository: *809 + type: *349 + organization: *826 + repository: *827 sender: *4 required: - action @@ -160776,11 +162471,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160797,7 +162492,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -161379,11 +163074,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *806 - installation: *807 - issue: *839 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *857 + organization: *826 + repository: *827 sender: *4 required: - action @@ -161463,12 +163158,12 @@ webhooks: type: string enum: - typed - enterprise: *806 - installation: *807 - issue: *840 - type: *331 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *858 + type: *349 + organization: *826 + repository: *827 sender: *4 required: - action @@ -161549,7 +163244,7 @@ webhooks: type: string enum: - unassigned - assignee: &864 + assignee: &882 title: User type: - object @@ -161621,11 +163316,11 @@ webhooks: required: - login - id - enterprise: *806 - installation: *807 - issue: *840 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *858 + organization: *826 + repository: *827 sender: *4 required: - action @@ -161704,12 +163399,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *806 - installation: *807 - issue: *840 - label: *832 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *858 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -161789,8 +163484,8 @@ webhooks: type: string enum: - unlocked - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -162624,11 +164319,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162645,7 +164340,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -162725,8 +164420,8 @@ webhooks: format: uri user_view_type: type: string - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -162806,11 +164501,11 @@ webhooks: type: string enum: - unpinned - enterprise: *806 - installation: *807 - issue: *839 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *857 + organization: *826 + repository: *827 sender: *4 required: - action @@ -162889,12 +164584,12 @@ webhooks: type: string enum: - untyped - enterprise: *806 - installation: *807 - issue: *840 - type: *331 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *858 + type: *349 + organization: *826 + repository: *827 sender: *4 required: - action @@ -162974,11 +164669,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - label: *832 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -163056,11 +164751,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - label: *832 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -163170,11 +164865,11 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - label: *832 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -163256,9 +164951,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *806 - installation: *807 - marketplace_purchase: &841 + enterprise: *824 + installation: *825 + marketplace_purchase: &859 title: Marketplace Purchase type: object required: @@ -163346,8 +165041,8 @@ webhooks: type: integer unit_count: type: integer - organization: *808 - previous_marketplace_purchase: &842 + organization: *826 + previous_marketplace_purchase: &860 title: Marketplace Purchase type: object properties: @@ -163431,7 +165126,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *809 + repository: *827 sender: *4 required: - action @@ -163511,10 +165206,10 @@ webhooks: - changed effective_date: type: string - enterprise: *806 - installation: *807 - marketplace_purchase: *841 - organization: *808 + enterprise: *824 + installation: *825 + marketplace_purchase: *859 + organization: *826 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -163602,7 +165297,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *809 + repository: *827 sender: *4 required: - action @@ -163684,10 +165379,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *806 - installation: *807 - marketplace_purchase: *841 - organization: *808 + enterprise: *824 + installation: *825 + marketplace_purchase: *859 + organization: *826 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -163773,7 +165468,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *809 + repository: *827 sender: *4 required: - action @@ -163854,8 +165549,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 marketplace_purchase: title: Marketplace Purchase type: object @@ -163941,9 +165636,9 @@ webhooks: type: integer unit_count: type: integer - organization: *808 - previous_marketplace_purchase: *842 - repository: *809 + organization: *826 + previous_marketplace_purchase: *860 + repository: *827 sender: *4 required: - action @@ -164023,12 +165718,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *806 - installation: *807 - marketplace_purchase: *841 - organization: *808 - previous_marketplace_purchase: *842 - repository: *809 + enterprise: *824 + installation: *825 + marketplace_purchase: *859 + organization: *826 + previous_marketplace_purchase: *860 + repository: *827 sender: *4 required: - action @@ -164130,11 +165825,11 @@ webhooks: type: string required: - to - enterprise: *806 - installation: *807 - member: *833 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + member: *851 + organization: *826 + repository: *827 sender: *4 required: - action @@ -164236,11 +165931,11 @@ webhooks: type: - string - 'null' - enterprise: *806 - installation: *807 - member: *833 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + member: *851 + organization: *826 + repository: *827 sender: *4 required: - action @@ -164319,11 +166014,11 @@ webhooks: type: string enum: - removed - enterprise: *806 - installation: *807 - member: *833 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + member: *851 + organization: *826 + repository: *827 sender: *4 required: - action @@ -164401,11 +166096,11 @@ webhooks: type: string enum: - added - enterprise: *806 - installation: *807 - member: *833 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + member: *851 + organization: *826 + repository: *827 scope: description: The scope of the membership. Currently, can only be `team`. @@ -164483,7 +166178,7 @@ webhooks: required: - login - id - team: &843 + team: &861 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -164713,11 +166408,11 @@ webhooks: type: string enum: - removed - enterprise: *806 - installation: *807 - member: *833 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + member: *851 + organization: *826 + repository: *827 scope: description: The scope of the membership. Currently, can only be `team`. @@ -164796,7 +166491,7 @@ webhooks: required: - login - id - team: *843 + team: *861 required: - action - scope @@ -164878,8 +166573,8 @@ webhooks: type: string enum: - checks_requested - installation: *807 - merge_group: &844 + installation: *825 + merge_group: &862 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -164898,15 +166593,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *503 + head_commit: *520 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -164992,10 +166687,10 @@ webhooks: - merged - invalidated - dequeued - installation: *807 - merge_group: *844 - organization: *808 - repository: *809 + installation: *825 + merge_group: *862 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165068,7 +166763,7 @@ webhooks: type: string enum: - deleted - enterprise: *806 + enterprise: *824 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -165177,12 +166872,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *807 - organization: *808 + installation: *825 + organization: *826 repository: anyOf: - type: 'null' - - *809 + - *827 sender: *4 required: - action @@ -165262,11 +166957,11 @@ webhooks: type: string enum: - closed - enterprise: *806 - installation: *807 - milestone: *838 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + milestone: *856 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165345,9 +167040,9 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - milestone: &845 + enterprise: *824 + installation: *825 + milestone: &863 title: Milestone description: A collection of related issues and pull requests. type: object @@ -165489,8 +167184,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165569,11 +167264,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - milestone: *838 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + milestone: *856 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165683,11 +167378,11 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - milestone: *838 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + milestone: *856 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165767,11 +167462,11 @@ webhooks: type: string enum: - opened - enterprise: *806 - installation: *807 - milestone: *845 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + milestone: *863 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165850,11 +167545,11 @@ webhooks: type: string enum: - blocked - blocked_user: *833 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + blocked_user: *851 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165933,11 +167628,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *833 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + blocked_user: *851 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165956,6 +167651,320 @@ 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: *135 + enterprise: *824 + 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: *824 + installation: *825 + 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: *135 + enterprise: *824 + installation: *825 + 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: *824 + installation: *825 + organization: *826 + sender: *4 + new_property_values: + type: array + description: The new custom property values. + items: *140 + old_property_values: + type: array + description: The old custom property values. + items: *140 + 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: |- @@ -166016,9 +168025,9 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - membership: &846 + enterprise: *824 + installation: *825 + membership: &864 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -166128,8 +168137,8 @@ webhooks: - role - organization_url - user - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -166207,11 +168216,11 @@ webhooks: type: string enum: - member_added - enterprise: *806 - installation: *807 - membership: *846 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + membership: *864 + organization: *826 + repository: *827 sender: *4 required: - action @@ -166290,8 +168299,8 @@ webhooks: type: string enum: - member_invited - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -166413,10 +168422,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 - user: *833 + user: *851 required: - action - invitation @@ -166494,11 +168503,11 @@ webhooks: type: string enum: - member_removed - enterprise: *806 - installation: *807 - membership: *846 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + membership: *864 + organization: *826 + repository: *827 sender: *4 required: - action @@ -166585,11 +168594,11 @@ webhooks: properties: from: type: string - enterprise: *806 - installation: *807 - membership: *846 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + membership: *864 + organization: *826 + repository: *827 sender: *4 required: - action @@ -166665,9 +168674,9 @@ webhooks: type: string enum: - published - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 package: description: Information about the package. type: object @@ -167190,7 +169199,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &847 + items: &865 title: Ruby Gems metadata type: object properties: @@ -167287,7 +169296,7 @@ webhooks: - owner - package_version - registry - repository: *809 + repository: *827 sender: *4 required: - action @@ -167363,9 +169372,9 @@ webhooks: type: string enum: - updated - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 package: description: Information about the package. type: object @@ -167727,7 +169736,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *847 + items: *865 source_url: type: string format: uri @@ -167798,7 +169807,7 @@ webhooks: - owner - package_version - registry - repository: *809 + repository: *827 sender: *4 required: - action @@ -167979,12 +169988,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *806 + enterprise: *824 id: type: integer - installation: *807 - organization: *808 - repository: *809 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - id @@ -168061,7 +170070,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &848 + personal_access_token_request: &866 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -168211,10 +170220,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *806 - organization: *808 + enterprise: *824 + organization: *826 sender: *4 - installation: *807 + installation: *825 required: - action - personal_access_token_request @@ -168291,11 +170300,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *848 - enterprise: *806 - organization: *808 + personal_access_token_request: *866 + enterprise: *824 + organization: *826 sender: *4 - installation: *807 + installation: *825 required: - action - personal_access_token_request @@ -168371,11 +170380,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *848 - enterprise: *806 - organization: *808 + personal_access_token_request: *866 + enterprise: *824 + organization: *826 sender: *4 - installation: *807 + installation: *825 required: - action - personal_access_token_request @@ -168450,11 +170459,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *848 - organization: *808 - enterprise: *806 + personal_access_token_request: *866 + organization: *826 + enterprise: *824 sender: *4 - installation: *807 + installation: *825 required: - action - personal_access_token_request @@ -168559,7 +170568,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *849 + last_response: *867 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -168591,8 +170600,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 zen: description: Random string of GitHub zen. @@ -168837,10 +170846,10 @@ webhooks: - from required: - note - enterprise: *806 - installation: *807 - organization: *808 - project_card: &850 + enterprise: *824 + installation: *825 + organization: *826 + project_card: &868 title: Project Card type: object properties: @@ -168963,7 +170972,7 @@ webhooks: - creator - created_at - updated_at - repository: *809 + repository: *827 sender: *4 required: - action @@ -169044,11 +171053,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - project_card: *850 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project_card: *868 + repository: *827 sender: *4 required: - action @@ -169128,9 +171137,9 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 project_card: title: Project Card type: object @@ -169260,7 +171269,7 @@ webhooks: repository: anyOf: - type: 'null' - - *809 + - *827 sender: *4 required: - action @@ -169354,11 +171363,11 @@ webhooks: - from required: - note - enterprise: *806 - installation: *807 - organization: *808 - project_card: *850 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project_card: *868 + repository: *827 sender: *4 required: - action @@ -169452,9 +171461,9 @@ webhooks: - from required: - column_id - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 project_card: allOf: - title: Project Card @@ -169651,7 +171660,7 @@ webhooks: type: string required: - after_id - repository: *809 + repository: *827 sender: *4 required: - action @@ -169731,10 +171740,10 @@ webhooks: type: string enum: - closed - enterprise: *806 - installation: *807 - organization: *808 - project: &852 + enterprise: *824 + installation: *825 + organization: *826 + project: &870 title: Project type: object properties: @@ -169861,7 +171870,7 @@ webhooks: - creator - created_at - updated_at - repository: *809 + repository: *827 sender: *4 required: - action @@ -169941,10 +171950,10 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - project_column: &851 + enterprise: *824 + installation: *825 + organization: *826 + project_column: &869 title: Project Column type: object properties: @@ -169984,7 +171993,7 @@ webhooks: - name - created_at - updated_at - repository: *809 + repository: *827 sender: *4 required: - action @@ -170063,14 +172072,14 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - project_column: *851 + enterprise: *824 + installation: *825 + organization: *826 + project_column: *869 repository: anyOf: - type: 'null' - - *809 + - *827 sender: *4 required: - action @@ -170159,11 +172168,11 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - organization: *808 - project_column: *851 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project_column: *869 + repository: *827 sender: *4 required: - action @@ -170243,11 +172252,11 @@ webhooks: type: string enum: - moved - enterprise: *806 - installation: *807 - organization: *808 - project_column: *851 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project_column: *869 + repository: *827 sender: *4 required: - action @@ -170327,11 +172336,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - project: *852 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project: *870 + repository: *827 sender: *4 required: - action @@ -170411,14 +172420,14 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - project: *852 + enterprise: *824 + installation: *825 + organization: *826 + project: *870 repository: anyOf: - type: 'null' - - *809 + - *827 sender: *4 required: - action @@ -170519,11 +172528,11 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - organization: *808 - project: *852 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project: *870 + repository: *827 sender: *4 required: - action @@ -170602,11 +172611,11 @@ webhooks: type: string enum: - reopened - enterprise: *806 - installation: *807 - organization: *808 - project: *852 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project: *870 + repository: *827 sender: *4 required: - action @@ -170687,9 +172696,9 @@ webhooks: type: string enum: - closed - installation: *807 - organization: *808 - projects_v2: *363 + installation: *825 + organization: *826 + projects_v2: *381 sender: *4 required: - action @@ -170770,9 +172779,9 @@ webhooks: type: string enum: - created - installation: *807 - organization: *808 - projects_v2: *363 + installation: *825 + organization: *826 + projects_v2: *381 sender: *4 required: - action @@ -170853,9 +172862,9 @@ webhooks: type: string enum: - deleted - installation: *807 - organization: *808 - projects_v2: *363 + installation: *825 + organization: *826 + projects_v2: *381 sender: *4 required: - action @@ -170976,9 +172985,9 @@ webhooks: type: string to: type: string - installation: *807 - organization: *808 - projects_v2: *363 + installation: *825 + organization: *826 + projects_v2: *381 sender: *4 required: - action @@ -171061,7 +173070,7 @@ webhooks: type: string enum: - archived - changes: &856 + changes: &874 type: object properties: archived_at: @@ -171077,9 +173086,9 @@ webhooks: - string - 'null' format: date-time - installation: *807 - organization: *808 - projects_v2_item: &853 + installation: *825 + organization: *826 + projects_v2_item: &871 title: Projects v2 Item description: An item belonging to a project type: object @@ -171097,7 +173106,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *370 + content_type: *388 creator: *4 created_at: type: string @@ -171219,9 +173228,9 @@ webhooks: - 'null' to: type: string - installation: *807 - organization: *808 - projects_v2_item: *853 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171303,9 +173312,9 @@ webhooks: type: string enum: - created - installation: *807 - organization: *808 - projects_v2_item: *853 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171386,9 +173395,9 @@ webhooks: type: string enum: - deleted - installation: *807 - organization: *808 - projects_v2_item: *853 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171493,7 +173502,7 @@ webhooks: oneOf: - type: string - type: integer - - &854 + - &872 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -171517,7 +173526,7 @@ webhooks: required: - id - name - - &855 + - &873 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -171557,8 +173566,8 @@ webhooks: oneOf: - type: string - type: integer - - *854 - - *855 + - *872 + - *873 type: - 'null' - string @@ -171581,9 +173590,9 @@ webhooks: - 'null' required: - body - installation: *807 - organization: *808 - projects_v2_item: *853 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171680,9 +173689,9 @@ webhooks: type: - string - 'null' - installation: *807 - organization: *808 - projects_v2_item: *853 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171765,10 +173774,10 @@ webhooks: type: string enum: - restored - changes: *856 - installation: *807 - organization: *808 - projects_v2_item: *853 + changes: *874 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171850,9 +173859,9 @@ webhooks: type: string enum: - reopened - installation: *807 - organization: *808 - projects_v2: *363 + installation: *825 + organization: *826 + projects_v2: *381 sender: *4 required: - action @@ -171933,9 +173942,9 @@ webhooks: type: string enum: - created - installation: *807 - organization: *808 - projects_v2_status_update: *857 + installation: *825 + organization: *826 + projects_v2_status_update: *875 sender: *4 required: - action @@ -172016,9 +174025,9 @@ webhooks: type: string enum: - deleted - installation: *807 - organization: *808 - projects_v2_status_update: *857 + installation: *825 + organization: *826 + projects_v2_status_update: *875 sender: *4 required: - action @@ -172164,9 +174173,9 @@ webhooks: - string - 'null' format: date - installation: *807 - organization: *808 - projects_v2_status_update: *857 + installation: *825 + organization: *826 + projects_v2_status_update: *875 sender: *4 required: - action @@ -172237,10 +174246,10 @@ webhooks: title: public event type: object properties: - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - repository @@ -172317,13 +174326,13 @@ webhooks: type: string enum: - assigned - assignee: *833 - enterprise: *806 - installation: *807 - number: &858 + assignee: *851 + enterprise: *824 + installation: *825 + number: &876 description: The pull request number. type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -174672,7 +176681,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -174754,11 +176763,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -177100,7 +179109,7 @@ webhooks: - draft reason: type: string - repository: *809 + repository: *827 sender: *4 required: - action @@ -177182,11 +179191,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -179528,7 +181537,7 @@ webhooks: - draft reason: type: string - repository: *809 + repository: *827 sender: *4 required: - action @@ -179610,13 +181619,13 @@ webhooks: type: string enum: - closed - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: &859 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: &877 allOf: - - *658 + - *677 - type: object properties: allow_auto_merge: @@ -179678,7 +181687,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *809 + repository: *827 sender: *4 required: - action @@ -179759,12 +181768,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: *859 - repository: *809 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: *877 + repository: *827 sender: *4 required: - action @@ -179844,11 +181853,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *806 - milestone: *368 - number: *858 - organization: *808 - pull_request: &860 + enterprise: *824 + milestone: *386 + number: *876 + organization: *826 + pull_request: &878 title: Pull Request type: object properties: @@ -182175,7 +184184,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -182254,11 +184263,11 @@ webhooks: type: string enum: - dequeued - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -184604,7 +186613,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *809 + repository: *827 sender: *4 required: - action @@ -184728,12 +186737,12 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: *859 - repository: *809 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: *877 + repository: *827 sender: *4 required: - action @@ -184813,11 +186822,11 @@ webhooks: type: string enum: - enqueued - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -187148,7 +189157,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -187228,11 +189237,11 @@ webhooks: type: string enum: - labeled - enterprise: *806 - installation: *807 - label: *832 - number: *858 - organization: *808 + enterprise: *824 + installation: *825 + label: *850 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -189580,7 +191589,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -189661,10 +191670,10 @@ webhooks: type: string enum: - locked - enterprise: *806 - installation: *807 - number: *858 - organization: *808 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -192010,7 +194019,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -192090,12 +194099,12 @@ webhooks: type: string enum: - milestoned - enterprise: *806 - milestone: *368 - number: *858 - organization: *808 - pull_request: *860 - repository: *809 + enterprise: *824 + milestone: *386 + number: *876 + organization: *826 + pull_request: *878 + repository: *827 sender: *4 required: - action @@ -192174,12 +194183,12 @@ webhooks: type: string enum: - opened - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: *859 - repository: *809 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: *877 + repository: *827 sender: *4 required: - action @@ -192260,12 +194269,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: *859 - repository: *809 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: *877 + repository: *827 sender: *4 required: - action @@ -192345,12 +194354,12 @@ webhooks: type: string enum: - reopened - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: *859 - repository: *809 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: *877 + repository: *827 sender: *4 required: - action @@ -192725,9 +194734,9 @@ webhooks: - start_side - side - reactions - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: type: object properties: @@ -194957,7 +196966,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *809 + repository: *827 sender: *4 required: - action @@ -195037,7 +197046,7 @@ webhooks: type: string enum: - deleted - comment: &862 + comment: &880 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. @@ -195330,9 +197339,9 @@ webhooks: - start_side - side - reactions - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: type: object properties: @@ -197550,7 +199559,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *809 + repository: *827 sender: *4 required: - action @@ -197630,11 +199639,11 @@ webhooks: type: string enum: - edited - changes: *861 - comment: *862 - enterprise: *806 - installation: *807 - organization: *808 + changes: *879 + comment: *880 + enterprise: *824 + installation: *825 + organization: *826 pull_request: type: object properties: @@ -199855,7 +201864,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *809 + repository: *827 sender: *4 required: - action @@ -199936,9 +201945,9 @@ webhooks: type: string enum: - dismissed - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: title: Simple Pull Request type: object @@ -202171,7 +204180,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *809 + repository: *827 review: description: The review that was affected. type: object @@ -202422,9 +204431,9 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: title: Simple Pull Request type: object @@ -204538,8 +206547,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *809 - review: &863 + repository: *827 + review: &881 description: The review that was affected. type: object properties: @@ -204777,12 +206786,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: description: The pull request number. type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -207129,7 +209138,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 requested_reviewer: title: User type: @@ -207215,12 +209224,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: description: The pull request number. type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -209574,7 +211583,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 requested_team: title: Team description: Groups of organization members that gives permissions @@ -209769,12 +211778,12 @@ webhooks: type: string enum: - review_requested - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: description: The pull request number. type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -212123,7 +214132,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 requested_reviewer: title: User type: @@ -212210,12 +214219,12 @@ webhooks: type: string enum: - review_requested - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: description: The pull request number. type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -214555,7 +216564,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 requested_team: title: Team description: Groups of organization members that gives permissions @@ -214739,9 +216748,9 @@ webhooks: type: string enum: - submitted - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: title: Simple Pull Request type: object @@ -216977,8 +218986,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *809 - review: *863 + repository: *827 + review: *881 sender: *4 required: - action @@ -217058,9 +219067,9 @@ webhooks: type: string enum: - resolved - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: title: Simple Pull Request type: object @@ -219191,7 +221200,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *809 + repository: *827 sender: *4 thread: type: object @@ -219588,9 +221597,9 @@ webhooks: type: string enum: - unresolved - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: title: Simple Pull Request type: object @@ -221704,7 +223713,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *809 + repository: *827 sender: *4 thread: type: object @@ -222103,10 +224112,10 @@ webhooks: type: string before: type: string - enterprise: *806 - installation: *807 - number: *858 - organization: *808 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -224441,7 +226450,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -224523,11 +226532,11 @@ webhooks: type: string enum: - unassigned - assignee: *864 - enterprise: *806 - installation: *807 - number: *858 - organization: *808 + assignee: *882 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -226877,7 +228886,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -226956,11 +228965,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *806 - installation: *807 - label: *832 - number: *858 - organization: *808 + enterprise: *824 + installation: *825 + label: *850 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -229299,7 +231308,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -229380,10 +231389,10 @@ webhooks: type: string enum: - unlocked - enterprise: *806 - installation: *807 - number: *858 - organization: *808 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -231712,7 +233721,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -231915,7 +233924,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *806 + enterprise: *824 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -232010,8 +234019,8 @@ webhooks: - url - author - committer - installation: *807 - organization: *808 + installation: *825 + organization: *826 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -232599,9 +234608,9 @@ webhooks: type: string enum: - published - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 registry_package: type: object properties: @@ -233078,7 +235087,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *847 + items: *865 summary: type: string tag_name: @@ -233134,7 +235143,7 @@ webhooks: - owner - package_version - registry - repository: *809 + repository: *827 sender: *4 required: - action @@ -233212,9 +235221,9 @@ webhooks: type: string enum: - updated - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 registry_package: type: object properties: @@ -233526,7 +235535,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *847 + items: *865 summary: type: string tag_name: @@ -233576,7 +235585,7 @@ webhooks: - owner - package_version - registry - repository: *809 + repository: *827 sender: *4 required: - action @@ -233653,10 +235662,10 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - release: &865 + enterprise: *824 + installation: *825 + organization: *826 + release: &883 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -233987,7 +235996,7 @@ webhooks: - updated_at - zipball_url - body - repository: *809 + repository: *827 sender: *4 required: - action @@ -234064,11 +236073,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - release: *865 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + release: *883 + repository: *827 sender: *4 required: - action @@ -234185,11 +236194,11 @@ webhooks: type: boolean required: - to - enterprise: *806 - installation: *807 - organization: *808 - release: *865 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + release: *883 + repository: *827 sender: *4 required: - action @@ -234267,9 +236276,9 @@ webhooks: type: string enum: - prereleased - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -234605,7 +236614,7 @@ webhooks: - string - 'null' format: uri - repository: *809 + repository: *827 sender: *4 required: - action @@ -234681,10 +236690,10 @@ webhooks: type: string enum: - published - enterprise: *806 - installation: *807 - organization: *808 - release: &866 + enterprise: *824 + installation: *825 + organization: *826 + release: &884 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -235017,7 +237026,7 @@ webhooks: - string - 'null' format: uri - repository: *809 + repository: *827 sender: *4 required: - action @@ -235093,11 +237102,11 @@ webhooks: type: string enum: - released - enterprise: *806 - installation: *807 - organization: *808 - release: *865 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + release: *883 + repository: *827 sender: *4 required: - action @@ -235173,11 +237182,11 @@ webhooks: type: string enum: - unpublished - enterprise: *806 - installation: *807 - organization: *808 - release: *866 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + release: *884 + repository: *827 sender: *4 required: - action @@ -235253,11 +237262,11 @@ webhooks: type: string enum: - published - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - repository_advisory: *711 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + repository_advisory: *730 sender: *4 required: - action @@ -235333,11 +237342,11 @@ webhooks: type: string enum: - reported - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - repository_advisory: *711 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + repository_advisory: *730 sender: *4 required: - action @@ -235413,10 +237422,10 @@ webhooks: type: string enum: - archived - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -235493,10 +237502,10 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -235574,10 +237583,10 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -235662,10 +237671,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -235780,10 +237789,10 @@ webhooks: - 'null' items: type: string - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -235855,10 +237864,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 status: type: string @@ -235939,10 +237948,10 @@ webhooks: type: string enum: - privatized - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -236019,10 +238028,10 @@ webhooks: type: string enum: - publicized - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -236116,10 +238125,10 @@ webhooks: - name required: - repository - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -236199,11 +238208,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - repository_ruleset: *158 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + repository_ruleset: *174 sender: *4 required: - action @@ -236281,11 +238290,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - repository_ruleset: *158 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + repository_ruleset: *174 sender: *4 required: - action @@ -236363,11 +238372,11 @@ webhooks: type: string enum: - edited - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - repository_ruleset: *158 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + repository_ruleset: *174 changes: type: object properties: @@ -236386,16 +238395,16 @@ webhooks: properties: added: type: array - items: *132 + items: *146 deleted: type: array - items: *132 + items: *146 updated: type: array items: type: object properties: - condition: *132 + condition: *146 changes: type: object properties: @@ -236428,16 +238437,16 @@ webhooks: properties: added: type: array - items: *679 + items: *698 deleted: type: array - items: *679 + items: *698 updated: type: array items: type: object properties: - rule: *679 + rule: *698 changes: type: object properties: @@ -236674,10 +238683,10 @@ webhooks: - from required: - owner - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -236755,10 +238764,10 @@ webhooks: type: string enum: - unarchived - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -236836,7 +238845,7 @@ webhooks: type: string enum: - create - alert: &867 + alert: &885 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -236960,10 +238969,10 @@ webhooks: type: string enum: - open - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -237173,10 +239182,10 @@ webhooks: type: string enum: - dismissed - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -237254,11 +239263,11 @@ webhooks: type: string enum: - reopen - alert: *867 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + alert: *885 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -237460,10 +239469,10 @@ webhooks: enum: - fixed - open - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -237541,17 +239550,17 @@ webhooks: type: string enum: - created - alert: &868 + alert: &886 type: object properties: - number: *109 - created_at: *116 + number: *119 + created_at: *126 updated_at: anyOf: - type: 'null' - - *117 - url: *114 - html_url: *115 + - *127 + url: *124 + html_url: *125 locations_url: type: string format: uri @@ -237655,10 +239664,10 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -237739,11 +239748,11 @@ webhooks: type: string enum: - created - alert: *868 - installation: *807 - location: *869 - organization: *808 - repository: *809 + alert: *886 + installation: *825 + location: *887 + organization: *826 + repository: *827 sender: *4 required: - location @@ -237981,11 +239990,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *868 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + alert: *886 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -238063,11 +240072,11 @@ webhooks: type: string enum: - reopened - alert: *868 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + alert: *886 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -238145,11 +240154,11 @@ webhooks: type: string enum: - resolved - alert: *868 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + alert: *886 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -238227,11 +240236,11 @@ webhooks: type: string enum: - validated - alert: *868 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + alert: *886 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -238361,10 +240370,10 @@ webhooks: - organization - enterprise - - repository: *809 - enterprise: *806 - installation: *807 - organization: *808 + repository: *827 + enterprise: *824 + installation: *825 + organization: *826 sender: *4 required: - action @@ -238442,11 +240451,11 @@ webhooks: type: string enum: - published - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - security_advisory: &870 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + security_advisory: &888 description: The details of the security advisory, including summary, description, and severity. type: object @@ -238463,7 +240472,7 @@ webhooks: required: - vector_string - score - cvss_severities: *111 + cvss_severities: *121 cwes: type: array items: @@ -238632,11 +240641,11 @@ webhooks: type: string enum: - updated - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - security_advisory: *870 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + security_advisory: *888 sender: *4 required: - action @@ -238709,10 +240718,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -238730,7 +240739,7 @@ webhooks: required: - vector_string - score - cvss_severities: *111 + cvss_severities: *121 cwes: type: array items: @@ -238898,11 +240907,11 @@ webhooks: from: type: object properties: - security_and_analysis: *377 - enterprise: *806 - installation: *807 - organization: *808 - repository: *443 + security_and_analysis: *394 + enterprise: *824 + installation: *825 + organization: *826 + repository: *460 sender: *4 required: - changes @@ -238980,12 +240989,12 @@ webhooks: type: string enum: - cancelled - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: &871 + sponsorship: &889 type: object properties: created_at: @@ -239290,12 +241299,12 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: *871 + sponsorship: *889 required: - action - sponsorship @@ -239383,12 +241392,12 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: *871 + sponsorship: *889 required: - action - changes @@ -239465,17 +241474,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &872 + effective_date: &890 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: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: *871 + sponsorship: *889 required: - action - sponsorship @@ -239549,7 +241558,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &873 + changes: &891 type: object properties: tier: @@ -239593,13 +241602,13 @@ webhooks: - from required: - tier - effective_date: *872 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + effective_date: *890 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: *871 + sponsorship: *889 required: - action - changes @@ -239676,13 +241685,13 @@ webhooks: type: string enum: - tier_changed - changes: *873 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + changes: *891 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: *871 + sponsorship: *889 required: - action - changes @@ -239756,10 +241765,10 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -239843,10 +241852,10 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -240280,15 +242289,15 @@ webhooks: type: - string - 'null' - enterprise: *806 + enterprise: *824 id: description: The unique identifier of the status. type: integer - installation: *807 + installation: *825 name: type: string - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 sha: description: The Commit SHA. @@ -240398,15 +242407,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *183 - parent_issue_repo: *67 + parent_issue: *200 + parent_issue_repo: *72 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *183 - installation: *807 - organization: *808 - repository: *809 + sub_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -240490,15 +242499,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *183 - parent_issue_repo: *67 + parent_issue: *200 + parent_issue_repo: *72 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *183 - installation: *807 - organization: *808 - repository: *809 + sub_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -240582,15 +242591,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *183 - sub_issue_repo: *67 + sub_issue: *200 + sub_issue_repo: *72 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *183 - installation: *807 - organization: *808 - repository: *809 + parent_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -240674,15 +242683,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *183 - sub_issue_repo: *67 + sub_issue: *200 + sub_issue_repo: *72 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *183 - installation: *807 - organization: *808 - repository: *809 + parent_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -240759,12 +242768,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - team: &874 + team: &892 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -240994,9 +243003,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 repository: title: Repository description: A git repository @@ -241466,7 +243475,7 @@ webhooks: - topics - visibility sender: *4 - team: *874 + team: *892 required: - action - team @@ -241542,9 +243551,9 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 repository: title: Repository description: A git repository @@ -242014,7 +244023,7 @@ webhooks: - topics - visibility sender: *4 - team: *874 + team: *892 required: - action - team @@ -242091,9 +244100,9 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 repository: title: Repository description: A git repository @@ -242563,7 +244572,7 @@ webhooks: - topics - visibility sender: *4 - team: *874 + team: *892 required: - action - team @@ -242707,9 +244716,9 @@ webhooks: - from required: - permissions - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 repository: title: Repository description: A git repository @@ -243179,7 +245188,7 @@ webhooks: - topics - visibility sender: *4 - team: *874 + team: *892 required: - action - changes @@ -243257,9 +245266,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 repository: title: Repository description: A git repository @@ -243729,7 +245738,7 @@ webhooks: - topics - visibility sender: *4 - team: *874 + team: *892 required: - action - team @@ -243805,10 +245814,10 @@ webhooks: type: string enum: - started - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -243881,17 +245890,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *806 + enterprise: *824 inputs: type: - object - 'null' additionalProperties: true - installation: *807 - organization: *808 + installation: *825 + organization: *826 ref: type: string - repository: *809 + repository: *827 sender: *4 workflow: type: string @@ -243973,10 +245982,10 @@ webhooks: type: string enum: - completed - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 workflow_job: allOf: @@ -244232,7 +246241,7 @@ webhooks: type: string required: - conclusion - deployment: *569 + deployment: *586 required: - action - repository @@ -244311,10 +246320,10 @@ webhooks: type: string enum: - in_progress - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 workflow_job: allOf: @@ -244596,7 +246605,7 @@ webhooks: required: - status - steps - deployment: *569 + deployment: *586 required: - action - repository @@ -244675,10 +246684,10 @@ webhooks: type: string enum: - queued - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 workflow_job: type: object @@ -244824,7 +246833,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *569 + deployment: *586 required: - action - repository @@ -244903,10 +246912,10 @@ webhooks: type: string enum: - waiting - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 workflow_job: type: object @@ -245053,7 +247062,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *569 + deployment: *586 required: - action - repository @@ -245133,12 +247142,12 @@ webhooks: type: string enum: - completed - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - workflow: *828 + workflow: *846 workflow_run: title: Workflow Run type: object @@ -246157,12 +248166,12 @@ webhooks: type: string enum: - in_progress - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - workflow: *828 + workflow: *846 workflow_run: title: Workflow Run type: object @@ -247166,12 +249175,12 @@ webhooks: type: string enum: - requested - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - workflow: *828 + workflow: *846 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 8d97d0fbd..ca8e736c5 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/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." @@ -5623,6 +5627,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.", @@ -5821,6 +5833,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.", @@ -6730,6 +6751,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.", @@ -6928,6 +6957,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.", @@ -7610,6 +7648,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.", @@ -7808,6 +7854,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.", @@ -8055,6 +8110,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.", @@ -8253,6 +8316,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.", @@ -10358,6 +10430,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.", @@ -10556,6 +10636,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.", @@ -11497,6 +11586,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.", @@ -11695,6 +11792,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.", @@ -12500,6 +12606,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.", @@ -12698,6 +12812,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.", @@ -13206,6 +13329,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.", @@ -13404,6 +13535,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.", @@ -19279,6 +19419,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -19409,6 +19556,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -19549,6 +19700,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -19569,6 +19727,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": [ @@ -19665,6 +19828,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -19795,6 +19965,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -19850,17 +20024,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": [ { @@ -19891,15 +20065,15 @@ "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", + "type": "integer", "examples": [ - "ubuntu-20.04" + 1 ] }, "platform": { @@ -19909,36 +20083,58 @@ "linux-x64" ] }, - "size_gb": { - "description": "Image size in GB.", + "total_versions_size": { + "description": "Total size of all the image versions in GB.", "type": "integer", "examples": [ - 86 + 200 ] }, - "display_name": { + "name": { "description": "Display name for this image.", "type": "string", "examples": [ - 20.04 + "CustomImage" ] }, "source": { "description": "The image provider.", "type": "string", - "enum": [ - "github", - "partner", + "examples": [ "custom" ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "Ready" + ] } }, "required": [ "id", "platform", - "size_gb", - "display_name", - "source" + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" ] } } @@ -19947,11 +20143,157 @@ "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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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" } } } @@ -19965,21 +20307,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.", @@ -19999,63 +20393,61 @@ "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", "examples": [ - "ubuntu-20.04" + "1.0.0" ] }, - "platform": { - "description": "The operating system of the image.", + "state": { + "description": "The state of image version.", "type": "string", "examples": [ - "linux-x64" + "Ready" ] }, "size_gb": { - "description": "Image size in GB.", + "description": "Image version size in GB.", "type": "integer", "examples": [ - 86 + 30 ] }, - "display_name": { - "description": "Display name for this image.", + "created_on": { + "description": "The creation date time of the image version.", "type": "string", "examples": [ - 20.04 + "2024-11-09T23:39:01Z" ] }, - "source": { - "description": "The image provider.", + "state_details": { + "description": "The image version status details.", "type": "string", - "enum": [ - "github", - "partner", - "custom" + "examples": [ + "None" ] } }, "required": [ - "id", - "platform", + "version", + "state", "size_gb", - "display_name", - "source" + "created_on", + "state_details" ] } } @@ -20064,11 +20456,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" + } + ] } } } @@ -20084,17 +20486,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": [ { @@ -20105,6 +20507,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": { @@ -20113,45 +20534,61 @@ "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.", - "examples": [ - 50 - ] - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "examples": [ - 17 - ] - } - }, - "required": [ - "maximum", - "current_usage" + "version": { + "description": "The version of image.", + "type": "string", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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" } } } @@ -20165,19 +20602,389 @@ "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", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 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", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 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.", + "examples": [ + 50 + ] + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "examples": [ + 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": [ { @@ -20444,6 +21251,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -20574,6 +21388,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -20689,6 +21507,13 @@ "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", + "null" + ] } } }, @@ -20775,6 +21600,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -20905,6 +21737,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -21060,6 +21896,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -21190,6 +22033,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -29414,6 +30261,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.", @@ -29612,6 +30467,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.", @@ -30252,6 +31116,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.", @@ -30450,6 +31322,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.", @@ -31310,6 +32191,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.", @@ -31508,6 +32397,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.", @@ -32765,6 +33663,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.", @@ -32963,6 +33869,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.", @@ -45110,6 +46025,658 @@ } } }, + "/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", + "examples": [ + "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", + "examples": [ + "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", @@ -45251,29 +46818,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).\"", @@ -48924,17 +50468,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": [ { @@ -48955,138 +50499,149 @@ "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" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "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" }, - { - "type": "array", + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], "items": { - "type": "string" - } + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" + } }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 + { + "type": "object", + "properties": { + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } }, - "maxItems": 200, - "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", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" + "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" + } + ] + } } } } @@ -49149,19 +50704,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": [ { @@ -49183,106 +50738,1936 @@ "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" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "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" }, - { - "type": "array", + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], "items": { - "type": "string" - } + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" + } }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 + { + "type": "object", + "properties": { + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } }, - "maxItems": 200, - "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", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property.", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property.", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property." + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property.", + "examples": [ + "enterprise_actors" + ] + } + }, + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "examples": [ + 1296269 + ] + }, + "organization_login": { + "type": "string", + "examples": [ + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" ] }, "minItems": 1, @@ -50591,72 +53976,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": [ @@ -50667,30 +54386,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": [ @@ -50703,62 +54414,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" ] }, { @@ -50824,29 +54480,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" ] }, { @@ -54766,36 +58467,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" ] }, { @@ -54911,29 +58838,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" ] }, { @@ -54999,29 +58971,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" ] }, { @@ -59938,7 +63955,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "secret-scanning", "subcategory": "secret-scanning" @@ -60968,6 +64985,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": { @@ -62886,7 +66916,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" ], @@ -63069,7 +67099,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -63077,7 +67107,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -63085,7 +67115,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -64617,6 +68647,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": { "type": [ "string", @@ -66167,6 +70207,876 @@ } } }, + "/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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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", @@ -66413,6 +71323,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": { "type": [ "string", @@ -114537,10 +119457,391 @@ } } }, + "/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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" ], @@ -114684,7 +119985,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -114692,7 +119993,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -114700,7 +120001,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -117275,6 +122576,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -117405,6 +122713,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -117545,6 +122857,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -117563,6 +122882,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": [ @@ -117660,6 +122984,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -117790,6 +123121,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -117845,6 +123180,639 @@ } } }, + "/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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", @@ -118439,6 +124407,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -118569,6 +124544,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -118684,6 +124663,13 @@ "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", + "null" + ] } } }, @@ -118770,6 +124756,309 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "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", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "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, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + 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", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + }, + "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", + "examples": [ + 5 + ] + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 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", + "examples": [ + "latest" + ] } }, "required": [ @@ -118900,291 +125189,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] - } - }, - "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", - "examples": [ - 5 - ] }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] - }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] - }, - "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", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "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, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "image_gen": { "type": "boolean", - "examples": [ - 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", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -125175,6 +131183,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -125305,6 +131320,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -135677,6 +141696,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", @@ -138601,7 +144724,10 @@ }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", - "type": "array", + "type": [ + "array", + "null" + ], "minItems": 1, "items": { "type": "object", @@ -138635,8 +144761,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -158163,29 +164300,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).\"", @@ -180277,6 +186391,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.", @@ -180475,6 +186597,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.", @@ -181399,6 +187530,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.", @@ -181597,6 +187736,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.", @@ -217689,17 +223837,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } }, @@ -226675,17 +232827,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -405202,16 +411358,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).\"", @@ -405239,29 +411385,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": { @@ -449740,6 +455863,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.", @@ -449938,6 +456069,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.", @@ -631363,7 +637503,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" ], @@ -724555,6 +730695,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.", @@ -724753,6 +730901,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.", @@ -797553,6 +803710,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.", @@ -797751,6 +803916,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.", @@ -805632,17 +811806,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -814591,17 +820769,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -843270,7 +849452,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" ], @@ -843401,7 +849583,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -843409,7 +849591,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -843417,7 +849599,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -1052687,6 +1058869,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.", @@ -1052885,6 +1059075,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.", @@ -1055769,6 +1061968,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.", @@ -1055967,6 +1062174,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.", @@ -1058756,6 +1064972,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.", @@ -1058954,6 +1065178,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.", @@ -1061743,6 +1067976,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.", @@ -1061941,6 +1068182,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.", @@ -1064864,6 +1071114,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.", @@ -1065062,6 +1071320,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.", @@ -1067992,6 +1074259,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.", @@ -1068190,6 +1074465,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.", @@ -1073115,6 +1079399,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.", @@ -1073313,6 +1079605,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.", @@ -1239500,6 +1245801,1944 @@ } } }, + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "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", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index f0616924a..22744cd35 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/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 - - &97 + - &102 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 - - &98 + - &103 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 - - &99 + - &104 name: direction description: The direction to sort the results by. in: query @@ -703,7 +705,7 @@ paths: required: - vector_string - score - cvss_severities: &111 + cvss_severities: &121 type: - object - 'null' @@ -750,7 +752,7 @@ paths: required: - vector_string - score - epss: &112 + epss: &122 type: - object - 'null' @@ -913,7 +915,7 @@ paths: - subscriptions_url - type - url - type: &397 + type: &414 type: string description: The type of credit the user is receiving. enum: @@ -1046,7 +1048,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &224 + schema: &242 title: Validation Error Simple description: Validation Error Simple type: object @@ -1079,7 +1081,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: - - &713 + - &732 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1664,7 +1666,7 @@ paths: schema: type: integer default: 30 - - &309 + - &327 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 @@ -1680,7 +1682,7 @@ paths: application/json: schema: type: array - items: &310 + items: &328 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1776,7 +1778,7 @@ paths: - installation_id - repository_id examples: - default: &311 + default: &329 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1808,7 +1810,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &723 + schema: &742 title: Scim Error description: Scim Error type: object @@ -1839,7 +1841,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &223 + schema: &241 title: Validation Error description: Validation Error type: object @@ -1911,7 +1913,7 @@ paths: description: Response content: application/json: - schema: &312 + schema: &330 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2046,7 +2048,7 @@ paths: - request - response examples: - default: &313 + default: &331 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2250,7 +2252,7 @@ paths: parameters: - *17 - *19 - - &189 + - &206 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) @@ -2504,6 +2506,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 @@ -2684,6 +2694,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 @@ -2858,7 +2877,7 @@ paths: application/json: schema: *20 examples: - default: &77 + default: &82 value: id: 1 account: @@ -3009,7 +3028,7 @@ paths: - selected repositories: type: array - items: &67 + items: &72 title: Repository description: A repository on GitHub. type: object @@ -3036,7 +3055,7 @@ paths: license: anyOf: - type: 'null' - - &186 + - &203 title: License Simple description: License Simple type: object @@ -7785,7 +7804,7 @@ paths: description: Response content: application/json: - schema: &225 + schema: &243 type: object properties: total_active_caches_count: @@ -7800,7 +7819,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &226 + default: &244 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7895,12 +7914,18 @@ paths: - github - partner - custom + version: + description: The image version of the hosted runner + pool. + type: string + examples: + - latest required: - id - size_gb - display_name - source - machine_size_details: &45 + machine_size_details: &50 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -7996,6 +8021,10 @@ paths: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled + for the hosted runners. required: - id - name @@ -8005,7 +8034,7 @@ paths: - public_ip_enabled - platform examples: - default: &227 + default: &245 value: total_count: 2 runners: @@ -8094,6 +8123,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -8113,6 +8148,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 @@ -8135,7 +8175,7 @@ paths: application/json: schema: *42 examples: - default: &46 + default: &51 value: id: 5 name: My hosted ubuntu runner @@ -8162,6 +8202,322 @@ 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: + - *39 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: &43 + 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 + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with + the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the + image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with + the image. + type: string + examples: + - Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + examples: + default: &45 + 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: + - *39 + - &44 + 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: *43 + examples: + default: &246 + 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: + - *39 + - *44 + 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: + - *44 + - *39 + 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: &46 + 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 + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - None + required: + - version + - state + - size_gb + - created_on + - state_details + examples: + default: *45 + 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: + - *39 + - *44 + - &47 + 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: *46 + examples: + default: &247 + 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: + - *39 + - *44 + - *47 + 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 @@ -8190,7 +8546,7 @@ paths: type: integer images: type: array - items: &43 + items: &48 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -8230,7 +8586,7 @@ paths: - display_name - source examples: - default: &44 + default: &49 value: id: ubuntu-20.04 platform: linux-x64 @@ -8270,9 +8626,9 @@ paths: type: integer images: type: array - items: *43 + items: *48 examples: - default: *44 + default: *49 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8295,7 +8651,7 @@ paths: description: Response content: application/json: - schema: &228 + schema: &248 type: object properties: public_ips: @@ -8322,7 +8678,7 @@ paths: required: - public_ips examples: - default: &229 + default: &249 value: public_ips: current_usage: 17 @@ -8360,9 +8716,9 @@ paths: type: integer machine_specs: type: array - items: *45 + items: *50 examples: - default: &230 + default: &250 value: id: 4-core cpu_cores: 4 @@ -8430,7 +8786,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise parameters: - *39 - - &47 + - &52 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -8444,7 +8800,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 headers: Link: *41 x-github: @@ -8465,7 +8821,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise parameters: - *39 - - *47 + - *52 requestBody: required: true content: @@ -8491,6 +8847,12 @@ 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 + - 'null' examples: default: value: @@ -8505,7 +8867,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -8522,7 +8884,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise parameters: - *39 - - *47 + - *52 responses: '202': description: Response @@ -8530,7 +8892,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8599,7 +8961,7 @@ paths: schema: type: object properties: - enabled_organizations: &48 + enabled_organizations: &53 type: string description: The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. @@ -8612,7 +8974,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: &49 + allowed_actions: &54 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -8620,12 +8982,12 @@ paths: - all - local_only - selected - selected_actions_url: &233 + selected_actions_url: &253 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: &50 + sha_pinning_required: &55 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -8667,9 +9029,9 @@ paths: schema: type: object properties: - enabled_organizations: *48 - allowed_actions: *49 - sha_pinning_required: *50 + enabled_organizations: *53 + allowed_actions: *54 + sha_pinning_required: *55 required: - enabled_organizations examples: @@ -8700,7 +9062,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &235 + schema: &255 type: object properties: days: @@ -8718,7 +9080,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &724 + '401': &743 description: Authorization failure '404': *6 x-github: @@ -8746,7 +9108,7 @@ paths: required: true content: application/json: - schema: &236 + schema: &256 type: object properties: days: @@ -8781,7 +9143,7 @@ paths: description: Response content: application/json: - schema: &51 + schema: &56 type: object properties: approval_policy: @@ -8795,7 +9157,7 @@ paths: required: - approval_policy examples: - default: &237 + default: &257 value: approval_policy: first_time_contributors '404': *6 @@ -8824,7 +9186,7 @@ paths: required: true content: application/json: - schema: *51 + schema: *56 examples: default: summary: Set approval policy to first time contributors @@ -8853,7 +9215,7 @@ paths: description: Response content: application/json: - schema: &238 + schema: &258 type: object required: - run_workflows_from_fork_pull_requests @@ -8879,7 +9241,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &52 + default: &57 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -8907,7 +9269,7 @@ paths: required: true content: application/json: - schema: &239 + schema: &259 type: object required: - run_workflows_from_fork_pull_requests @@ -8930,7 +9292,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *52 + default: *57 responses: '204': description: Empty response for successful settings update @@ -8970,7 +9332,7 @@ paths: type: number organizations: type: array - items: &62 + items: &67 title: Organization Simple description: A GitHub organization. type: object @@ -9045,7 +9407,7 @@ paths: - total_count - organizations examples: - default: &63 + default: &68 value: total_count: 1 organizations: @@ -9124,7 +9486,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *39 - - &53 + - &58 name: org_id description: The unique identifier of the organization. in: path @@ -9153,7 +9515,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *39 - - *53 + - *58 responses: '204': description: Response @@ -9182,7 +9544,7 @@ paths: description: Response content: application/json: - schema: &54 + schema: &59 type: object properties: github_owned_allowed: @@ -9203,7 +9565,7 @@ paths: items: type: string examples: - default: &55 + default: &60 value: github_owned_allowed: true verified_allowed: false @@ -9236,9 +9598,9 @@ paths: required: true content: application/json: - schema: *54 + schema: *59 examples: - selected_actions: *55 + selected_actions: *60 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9343,17 +9705,17 @@ paths: description: Success response content: application/json: - schema: &242 + schema: &262 type: object properties: - default_workflow_permissions: &56 + default_workflow_permissions: &61 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &57 + can_approve_pull_request_reviews: &62 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -9361,7 +9723,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &58 + default: &63 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -9391,13 +9753,13 @@ paths: required: true content: application/json: - schema: &243 + schema: &263 type: object properties: - default_workflow_permissions: *56 - can_approve_pull_request_reviews: *57 + default_workflow_permissions: *61 + can_approve_pull_request_reviews: *62 examples: - default: *58 + default: *63 responses: '204': description: Success response @@ -9442,7 +9804,7 @@ paths: type: number runner_groups: type: array - items: &59 + items: &64 type: object properties: id: @@ -9623,9 +9985,9 @@ paths: description: Response content: application/json: - schema: *59 + schema: *64 examples: - default: &60 + default: &65 value: id: 2 name: octo-runner-group @@ -9660,7 +10022,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: - *39 - - &61 + - &66 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -9672,9 +10034,9 @@ paths: description: Response content: application/json: - schema: *59 + schema: *64 examples: - default: *60 + default: *65 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9694,7 +10056,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: - *39 - - *61 + - *66 requestBody: required: false content: @@ -9748,7 +10110,7 @@ paths: description: Response content: application/json: - schema: *59 + schema: *64 examples: default: value: @@ -9784,7 +10146,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: - *39 - - *61 + - *66 responses: '204': description: Response @@ -9808,7 +10170,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: - *39 - - *61 + - *66 - *17 - *19 responses: @@ -9823,12 +10185,12 @@ paths: type: number organizations: type: array - items: *62 + items: *67 required: - total_count - organizations examples: - default: *63 + default: *68 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9848,7 +10210,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: - *39 - - *61 + - *66 requestBody: required: true content: @@ -9894,8 +10256,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: - *39 - - *61 - - *53 + - *66 + - *58 responses: '204': description: Response @@ -9918,8 +10280,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: - *39 - - *61 - - *53 + - *66 + - *58 responses: '204': description: Response @@ -9943,7 +10305,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: - *39 - - *61 + - *66 - *17 - *19 responses: @@ -9958,7 +10320,7 @@ paths: type: number runners: type: array - items: &65 + items: &70 title: Self hosted runners description: A self hosted runner type: object @@ -9992,7 +10354,7 @@ paths: type: boolean labels: type: array - items: &69 + items: &74 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -10025,7 +10387,7 @@ paths: - total_count - runners examples: - default: &66 + default: &71 value: total_count: 2 runners: @@ -10085,7 +10447,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: - *39 - - *61 + - *66 requestBody: required: true content: @@ -10130,8 +10492,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: - *39 - - *61 - - &64 + - *66 + - &69 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -10160,8 +10522,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: - *39 - - *61 - - *64 + - *66 + - *69 responses: '204': description: Response @@ -10204,9 +10566,9 @@ paths: type: number runners: type: array - items: *65 + items: *70 examples: - default: *66 + default: *71 headers: Link: *41 x-github: @@ -10236,7 +10598,7 @@ paths: application/json: schema: type: array - items: &247 + items: &267 title: Runner Application description: Runner Application type: object @@ -10261,7 +10623,7 @@ paths: - download_url - filename examples: - default: &248 + default: &268 value: - os: osx architecture: x64 @@ -10345,7 +10707,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &249 + '201': &269 description: Response content: application/json: @@ -10355,7 +10717,7 @@ paths: - runner - encoded_jit_config properties: - runner: *65 + runner: *70 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -10384,7 +10746,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': &107 + '409': &112 description: Conflict content: application/json: @@ -10422,7 +10784,7 @@ paths: description: Response content: application/json: - schema: &68 + schema: &73 title: Authentication Token description: Authentication Token type: object @@ -10446,7 +10808,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *67 + items: *72 single_file: type: - string @@ -10464,7 +10826,7 @@ paths: - token - expires_at examples: - default: &250 + default: &270 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10502,9 +10864,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *73 examples: - default: &251 + default: &271 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10528,15 +10890,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - *39 - - *64 + - *69 responses: '200': description: Response content: application/json: - schema: *65 + schema: *70 examples: - default: &252 + default: &272 value: id: 23 name: MBP @@ -10576,7 +10938,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - *39 - - *64 + - *69 responses: '204': description: Response @@ -10601,9 +10963,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: - *39 - - *64 + - *69 responses: - '200': &70 + '200': &75 description: Response content: application/json: @@ -10617,7 +10979,7 @@ paths: type: integer labels: type: array - items: *69 + items: *74 examples: default: value: @@ -10655,7 +11017,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: - *39 - - *64 + - *69 requestBody: required: true content: @@ -10679,7 +11041,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -10702,7 +11064,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: - *39 - - *64 + - *69 requestBody: required: true content: @@ -10727,7 +11089,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -10750,9 +11112,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: - *39 - - *64 + - *69 responses: - '200': &253 + '200': &273 description: Response content: application/json: @@ -10766,7 +11128,7 @@ paths: type: integer labels: type: array - items: *69 + items: *74 examples: default: value: @@ -10807,8 +11169,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: - *39 - - *64 - - &254 + - *69 + - &274 name: name description: The name of a self-hosted runner's custom label. in: path @@ -10816,7 +11178,7 @@ paths: schema: type: string responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -10841,13 +11203,13 @@ paths: description: Response content: application/json: - schema: &75 + schema: &80 title: Announcement Banner description: Announcement at either the repository, organization, or enterprise level type: object properties: - announcement: &71 + announcement: &76 type: - string - 'null' @@ -10856,7 +11218,7 @@ paths: 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)." examples: - Very **important** announcement about _something_. - expires_at: &72 + expires_at: &77 type: - string - 'null' @@ -10868,7 +11230,7 @@ paths: it to an empty string.' examples: - '"2021-01-01T00:00:00.000-07:00"' - user_dismissible: &73 + user_dismissible: &78 type: - boolean - 'null' @@ -10881,7 +11243,7 @@ paths: - expires_at - user_dismissible examples: - default: &74 + default: &79 summary: Announcement banner value: announcement: Very **important** announcement about _something_. @@ -10905,18 +11267,18 @@ paths: required: true content: application/json: - schema: &261 + schema: &281 title: Enterprise Announcement description: Enterprise global announcement type: object properties: - announcement: *71 - expires_at: *72 - user_dismissible: *73 + announcement: *76 + expires_at: *77 + user_dismissible: *78 required: - announcement examples: - default: *74 + default: *79 parameters: - *39 responses: @@ -10924,9 +11286,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *80 examples: - default: *74 + default: *79 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -11025,7 +11387,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - *39 - - &76 + - &81 name: org description: The organization name. The name is not case sensitive. in: path @@ -11042,7 +11404,7 @@ paths: application/json: schema: type: array - items: &78 + items: &83 title: Accessible Repository description: A repository that may be made accessible to a GitHub App. @@ -11096,7 +11458,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: - *39 - - *76 + - *81 - *17 - *19 responses: @@ -11195,7 +11557,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: - *39 - - *76 + - *81 responses: '200': description: A GitHub App installation that was installed previously. @@ -11203,14 +11565,14 @@ paths: application/json: schema: *20 examples: - default: *77 + default: *82 '201': description: A GitHub App installation. content: application/json: schema: *20 examples: - default: *77 + default: *82 requestBody: required: true content: @@ -11278,7 +11640,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: - *39 - - *76 + - *81 - *21 responses: '204': @@ -11306,7 +11668,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: - *39 - - *76 + - *81 - *21 - *17 - *19 @@ -11318,7 +11680,7 @@ paths: application/json: schema: type: array - items: *78 + items: *83 examples: default: value: @@ -11347,7 +11709,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: - *39 - - *76 + - *81 - *21 requestBody: required: true @@ -11387,7 +11749,7 @@ paths: application/json: schema: *20 examples: - default: *77 + default: *82 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -11408,7 +11770,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - *39 - - *76 + - *81 - *21 responses: '200': @@ -11418,7 +11780,7 @@ paths: application/json: schema: type: array - items: *78 + items: *83 examples: default: value: @@ -11469,7 +11831,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - *39 - - *76 + - *81 - *21 responses: '200': @@ -11479,7 +11841,7 @@ paths: application/json: schema: type: array - items: *78 + items: *83 examples: default: value: @@ -11556,7 +11918,7 @@ paths: required: false schema: type: string - - &262 + - &282 name: include description: |- The event types to include: @@ -11574,7 +11936,7 @@ paths: - web - git - all - - &263 + - &283 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. @@ -11582,7 +11944,7 @@ paths: required: false schema: type: string - - &264 + - &284 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. @@ -11590,7 +11952,7 @@ paths: required: false schema: type: string - - &265 + - &285 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11612,7 +11974,7 @@ paths: application/json: schema: type: array - items: &266 + items: &286 type: object properties: "@timestamp": @@ -11734,7 +12096,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &267 + default: &287 value: - "@timestamp": 1606929874512 action: team.add_member @@ -11914,7 +12276,7 @@ paths: vendor_specific: type: object oneOf: - - &82 + - &87 title: AzureBlobConfig description: Azure Blob Config for audit log streaming configuration. type: object @@ -11933,7 +12295,7 @@ paths: - key_id - encrypted_sas_url - container - - &83 + - &88 title: AzureHubConfig description: Azure Event Hubs Config for audit log streaming configuration. type: object @@ -11952,7 +12314,7 @@ paths: - name - encrypted_connstring - key_id - - &84 + - &89 title: AmazonS3OIDCConfig description: Amazon S3 OIDC Config for audit log streaming configuration. type: object @@ -11980,7 +12342,7 @@ paths: - bucket - key_id - region - - &85 + - &90 title: AmazonS3AccessKeysConfig description: Amazon S3 Access Keys Config for audit log streaming configuration. @@ -12014,7 +12376,7 @@ paths: - encrypted_secret_key - key_id - region - - &86 + - &91 title: SplunkConfig description: Splunk Config for Audit Log Stream Configuration type: object @@ -12042,7 +12404,7 @@ paths: - key_id - port - ssl_verify - - &87 + - &92 title: HecConfig description: Hec Config for Audit Log Stream Configuration type: object @@ -12074,7 +12436,7 @@ paths: - key_id - port - ssl_verify - - &88 + - &93 title: GoogleCloudConfig description: Google Cloud Config for audit log streaming configuration. type: object @@ -12092,7 +12454,7 @@ paths: - bucket - key_id - encrypted_json_credentials - - &89 + - &94 title: DatadogConfig description: Datadog Config for audit log streaming configuration. type: object @@ -12123,7 +12485,7 @@ paths: - stream_type - vendor_specific examples: - default: &90 + default: &95 value: enabled: false stream_type: Azure Event Hubs @@ -12137,7 +12499,7 @@ paths: description: The audit log stream configuration was created successfully. content: application/json: - schema: &79 + schema: &84 title: Get an audit log streaming configuration description: Get an audit log streaming configuration for an enterprise. type: object @@ -12169,7 +12531,7 @@ paths: - created_at - updated_at examples: - default: &80 + default: &85 value: id: 1 stream_type: Splunk @@ -12198,7 +12560,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: - *39 - - &81 + - &86 name: stream_id description: The ID of the audit log stream configuration. in: path @@ -12210,9 +12572,9 @@ paths: description: Lists one audit log stream configuration via stream ID. content: application/json: - schema: *79 + schema: *84 examples: - default: *80 + default: *85 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -12232,7 +12594,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - *39 - - *81 + - *86 requestBody: required: true content: @@ -12258,28 +12620,28 @@ paths: vendor_specific: type: object oneOf: - - *82 - - *83 - - *84 - - *85 - - *86 - *87 - *88 - *89 + - *90 + - *91 + - *92 + - *93 + - *94 required: - enabled - stream_type - vendor_specific examples: - default: *90 + default: *95 responses: '200': description: Successful update content: application/json: - schema: *79 + schema: *84 examples: - default: *80 + default: *85 '422': description: Validation error content: @@ -12310,7 +12672,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: - *39 - - *81 + - *86 responses: '204': description: The audit log stream configuration was deleted successfully. @@ -12337,13 +12699,13 @@ paths: subcategory: bypass-requests parameters: - *39 - - &91 + - &96 name: organization_name description: The name of the organization to filter on. in: query schema: type: string - - &92 + - &97 name: reviewer description: Filter bypass requests by the handle of the GitHub user who reviewed the bypass request. @@ -12351,7 +12713,7 @@ paths: required: false schema: type: string - - &93 + - &98 name: requester description: Filter bypass requests by the handle of the GitHub user who requested the bypass. @@ -12359,7 +12721,7 @@ paths: required: false schema: type: string - - &94 + - &99 name: time_period description: |- The time period to filter by. @@ -12375,7 +12737,7 @@ paths: - week - month default: day - - &95 + - &100 name: request_status description: The status of the bypass request to filter on. When specified, only requests with this status will be returned. @@ -12402,7 +12764,7 @@ paths: application/json: schema: type: array - items: &268 + items: &288 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12528,7 +12890,7 @@ paths: - array - 'null' description: The responses to the bypass request. - items: &96 + items: &101 title: Bypass response description: A response made by a delegated bypasser to a bypass request. @@ -12574,7 +12936,7 @@ paths: examples: - https://github.com/octo-org/smile/exemptions/1 examples: - default: &269 + default: &289 value: - id: 21 number: 42 @@ -12665,11 +13027,11 @@ paths: subcategory: delegated-bypass parameters: - *39 - - *91 - - *92 - - *93 - - *94 - - *95 + - *96 + - *97 + - *98 + - *99 + - *100 - *17 - *19 responses: @@ -12679,7 +13041,7 @@ paths: application/json: schema: type: array - items: &271 + items: &291 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -12797,7 +13159,7 @@ paths: - array - 'null' description: The responses to the bypass request. - items: *96 + items: *101 url: type: string format: uri @@ -12810,7 +13172,7 @@ paths: examples: - https://github.com/octo-org/smile/exemptions/1 examples: - default: &272 + default: &292 value: - id: 21 number: 42 @@ -12895,17 +13257,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *39 - - &277 + - &297 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: &100 + schema: &105 type: string description: The name of the tool used to generate the code scanning analysis. - - &278 + - &298 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 @@ -12913,23 +13275,23 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &101 + schema: &106 type: - string - 'null' description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *97 - - *98 + - *102 + - *103 - *19 - *17 - - *99 + - *104 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &279 + schema: &299 type: string description: State of a code scanning alert. enum: @@ -12954,42 +13316,42 @@ paths: application/json: schema: type: array - items: &280 + items: &300 type: object properties: - number: &109 + number: &119 type: integer description: The security alert number. readOnly: true - created_at: &116 + created_at: &126 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: &117 + updated_at: &127 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: &114 + url: &124 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &115 + html_url: &125 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &509 + instances_url: &526 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &102 + state: &107 type: - string - 'null' @@ -12999,7 +13361,7 @@ paths: - dismissed - fixed - - fixed_at: &119 + fixed_at: &129 type: - string - 'null' @@ -13011,7 +13373,7 @@ paths: anyOf: - type: 'null' - *4 - dismissed_at: &118 + dismissed_at: &128 type: - string - 'null' @@ -13019,7 +13381,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &510 + dismissed_reason: &527 type: - string - 'null' @@ -13030,14 +13392,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &511 + dismissed_comment: &528 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &512 + rule: &529 type: object properties: id: @@ -13098,26 +13460,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &513 + tool: &530 type: object properties: - name: *100 + name: *105 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *101 - most_recent_instance: &514 + guid: *106 + most_recent_instance: &531 type: object properties: - ref: &507 + ref: &524 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &524 + analysis_key: &541 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13128,13 +13490,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &525 + category: &542 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: *102 + state: *107 commit_sha: type: string message: @@ -13175,7 +13537,7 @@ paths: - test - library - - repository: &108 + repository: &113 title: Simple Repository description: A GitHub repository. type: object @@ -13519,7 +13881,7 @@ paths: - most_recent_instance - repository examples: - default: &281 + default: &301 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -13750,7 +14112,7 @@ paths: headers: Link: *41 '404': *6 - '503': &163 + '503': &179 description: Service unavailable content: application/json: @@ -13794,8 +14156,8 @@ paths: schema: type: integer default: 30 - - *97 - - *98 + - *102 + - *103 responses: '200': description: Response @@ -13803,7 +14165,7 @@ paths: application/json: schema: type: array - items: &103 + items: &108 type: object description: A code security configuration properties: @@ -14178,7 +14540,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &282 + code_scanning_options: &302 type: - object - 'null' @@ -14197,7 +14559,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &106 + code_scanning_default_setup_options: &111 type: - object - 'null' @@ -14316,9 +14678,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *103 + schema: *108 examples: - default: &104 + default: &109 value: id: 1325 target_type: enterprise @@ -14376,7 +14738,7 @@ paths: description: Response content: application/json: - schema: &284 + schema: &304 type: array description: A list of default code security configurations items: @@ -14390,9 +14752,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *103 + configuration: *108 examples: - default: &285 + default: &305 value: - default_for_new_repos: public configuration: @@ -14481,7 +14843,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - *39 - - &105 + - &110 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -14493,9 +14855,9 @@ paths: description: Response content: application/json: - schema: *103 + schema: *108 examples: - default: *104 + default: *109 '304': *35 '403': *27 '404': *6 @@ -14520,7 +14882,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - *39 - - *105 + - *110 requestBody: required: true content: @@ -14599,7 +14961,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *106 + code_scanning_default_setup_options: *111 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -14687,13 +15049,13 @@ paths: description: Response content: application/json: - schema: *103 + schema: *108 examples: - default: *104 + default: *109 '304': *35 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14717,14 +15079,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - *39 - - *105 + - *110 responses: - '204': &129 + '204': &139 description: A header with no content is returned. '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14749,7 +15111,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - *39 - - *105 + - *110 requestBody: required: true content: @@ -14776,7 +15138,7 @@ paths: '202': *37 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14801,7 +15163,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: - *39 - - *105 + - *110 requestBody: required: true content: @@ -14841,12 +15203,12 @@ paths: - none - private_and_internal - public - configuration: *103 + configuration: *108 examples: default: value: default_for_new_repos: all - configuration: &283 + configuration: &303 value: id: 1325 target_type: organization @@ -14903,7 +15265,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - *39 - - *105 + - *110 - 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)." @@ -14912,8 +15274,8 @@ paths: schema: type: integer default: 30 - - *97 - - *98 + - *102 + - *103 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -14931,7 +15293,7 @@ paths: application/json: schema: type: array - items: &286 + items: &306 type: object description: Repositories associated with a code security configuration and attachment status @@ -14949,13 +15311,13 @@ paths: - failed - updating - removed_by_enterprise - repository: *108 + repository: *113 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: &287 + repository: &307 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -15438,7 +15800,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &120 + items: &130 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -15451,12 +15813,12 @@ paths: organization: anyOf: - type: 'null' - - *62 + - *67 assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &273 + - &293 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15533,7 +15895,7 @@ paths: parent: anyOf: - type: 'null' - - &344 + - &362 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -15651,7 +16013,7 @@ paths: - slug - parent - type - - &174 + - &190 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -15774,7 +16136,7 @@ paths: - created_at additionalProperties: false examples: - default: &121 + default: &131 value: total_seats: 2 seats: @@ -16226,7 +16588,7 @@ paths: application/json: schema: type: array - items: &171 + items: &187 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -16541,7 +16903,7 @@ paths: - date additionalProperties: true examples: - default: &172 + default: &188 value: - date: '2024-06-24' total_active_users: 24 @@ -16643,7 +17005,7 @@ paths: '500': *38 '403': *27 '404': *6 - '422': &173 + '422': &189 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -16654,6 +17016,213 @@ 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: + - *39 + - &114 + name: day + description: The day to request data for, in `YYYY-MM-DD` format. + in: query + required: true + schema: + type: string + format: date + examples: + - '2025-10-13' + responses: + '200': + description: Response + content: + application/json: + schema: &115 + 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: &116 + 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': *38 + '403': *27 + '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: + - *39 + responses: + '200': + description: Response + content: + application/json: + schema: &117 + 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: &118 + 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': *38 + '403': *27 + '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: + - *39 + - *114 + responses: + '200': + description: Response + content: + application/json: + schema: *115 + examples: + default: *116 + '500': *38 + '403': *27 + '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: + - *39 + responses: + '200': + description: Response + content: + application/json: + schema: *117 + examples: + default: *118 + '500': *38 + '403': *27 + '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 @@ -16673,7 +17242,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *39 - - &294 + - &314 name: state in: query description: |- @@ -16682,7 +17251,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &295 + - &315 name: severity in: query description: |- @@ -16691,7 +17260,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &296 + - &316 name: ecosystem in: query description: |- @@ -16700,14 +17269,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &297 + - &317 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 - - &298 + - &318 name: epss_percentage in: query description: |- @@ -16719,7 +17288,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 - - &560 + - &577 name: has in: query description: |- @@ -16733,7 +17302,7 @@ paths: type: string enum: - patch - - &299 + - &319 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -16743,7 +17312,7 @@ paths: enum: - development - runtime - - &300 + - &320 name: sort in: query description: |- @@ -16758,34 +17327,9 @@ paths: - updated - epss_percentage default: created - - *99 - - *97 - - *98 - - &301 - 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 - - &302 - 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 + - *104 + - *102 + - *103 - *17 responses: '200': @@ -16794,11 +17338,11 @@ paths: application/json: schema: type: array - items: &303 + items: &321 type: object description: A Dependabot alert. properties: - number: *109 + number: *119 state: type: string description: The state of the Dependabot alert. @@ -16813,7 +17357,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &110 + package: &120 type: object description: Details for the vulnerable package. readOnly: true @@ -16861,7 +17405,7 @@ paths: - direct - transitive - - security_advisory: &561 + security_advisory: &578 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -16892,13 +17436,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &113 + items: &123 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *110 + package: *120 severity: type: string description: The severity of the vulnerability. @@ -16966,8 +17510,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *111 - epss: *112 + cvss_severities: *121 + epss: *122 cwes: type: array description: Details for the advisory pertaining to Common @@ -17067,12 +17611,12 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *113 - url: *114 - html_url: *115 - created_at: *116 - updated_at: *117 - dismissed_at: *118 + security_vulnerability: *123 + url: *124 + html_url: *125 + created_at: *126 + updated_at: *127 + dismissed_at: *128 dismissed_by: anyOf: - type: 'null' @@ -17096,8 +17640,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *119 - auto_dismissed_at: &562 + fixed_at: *129 + auto_dismissed_at: &579 type: - string - 'null' @@ -17105,7 +17649,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - repository: *108 + repository: *113 required: - number - state @@ -17124,7 +17668,7 @@ paths: - repository additionalProperties: false examples: - default: &304 + default: &322 value: - number: 2 state: dismissed @@ -17541,7 +18085,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: - *39 - - &178 + - &194 name: username description: The handle for the GitHub user account. in: path @@ -17563,9 +18107,9 @@ paths: teams or multiple organizations are only counted once. seats: type: array - items: *120 + items: *130 examples: - default: *121 + default: *131 '500': *38 '401': *23 '403': *27 @@ -17608,7 +18152,7 @@ paths: type: integer network_configurations: type: array - items: &122 + items: &132 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -17653,7 +18197,7 @@ paths: - name - created_on examples: - default: &407 + default: &424 value: total_count: 2 network_configurations: @@ -17731,9 +18275,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: &123 + default: &133 value: id: 123456789ABCDEF name: My network configuration @@ -17760,7 +18304,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: - *39 - - &124 + - &134 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -17772,9 +18316,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: *123 + default: *133 headers: Link: *41 x-github: @@ -17794,7 +18338,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: - *39 - - *124 + - *134 requestBody: required: true content: @@ -17833,9 +18377,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: *123 + default: *133 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -17853,7 +18397,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: - *39 - - *124 + - *134 responses: '204': description: Response @@ -17876,7 +18420,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: - *39 - - &408 + - &425 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -17888,7 +18432,7 @@ paths: description: Response content: application/json: - schema: &409 + schema: &426 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -17927,7 +18471,7 @@ paths: - subnet_id - region examples: - default: &410 + default: &427 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -17941,6 +18485,540 @@ 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: + - *39 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &135 + 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 + examples: + - organization + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - enterprise_actors + - enterprise_and_org_actors + - + description: Who can edit the values of the property + examples: + - enterprise_actors + required: + - property_name + - value_type + examples: + default: &136 + 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': *27 + '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: + - *39 + 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: *135 + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: *136 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *135 + examples: + default: *136 + '403': *27 + '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: + - *39 + - &137 + name: custom_property_name + description: The custom property name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: *135 + examples: + default: &138 + 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': *27 + '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: + - *39 + - *137 + 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 + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property. + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property. + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property. + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - enterprise_actors + - enterprise_and_org_actors + - + description: Who can edit the values of the property. + examples: + - enterprise_actors + 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: *135 + examples: + default: *138 + '403': *27 + '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: + - *39 + - *137 + responses: + '204': *139 + '403': *27 + '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: + - *39 + - *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 + examples: + - 1296269 + organization_login: + type: string + examples: + - Hello-World + properties: + type: array + items: &140 + 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 + type: + - 'null' + - string + - array + 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: *41 + '403': *27 + '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: + - *39 + 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: *140 + 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': *27 + '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 @@ -17962,7 +19040,7 @@ paths: application/json: schema: type: array - items: &125 + items: &141 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -18038,7 +19116,7 @@ paths: - property_name - value_type examples: - default: &126 + default: &142 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -18095,7 +19173,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *125 + items: *141 minItems: 1 maxItems: 100 required: @@ -18125,9 +19203,9 @@ paths: application/json: schema: type: array - items: *125 + items: *141 examples: - default: *126 + default: *142 '403': *27 '404': *6 x-github: @@ -18150,22 +19228,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - *39 - - *76 - - &127 - name: custom_property_name - description: The custom property name - in: path - required: true - schema: - type: string + - *81 + - *137 responses: '200': description: Response content: application/json: - schema: *125 + schema: *141 examples: - default: &128 + default: &143 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -18198,15 +19270,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - *39 - - *127 + - *137 responses: '200': description: Response content: application/json: - schema: *125 + schema: *141 examples: - default: *128 + default: *143 '403': *27 '404': *6 x-github: @@ -18228,12 +19300,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: - *39 - - *127 + - *137 requestBody: required: true content: application/json: - schema: &375 + schema: &393 title: Custom Property Set Payload description: Custom property set payload type: object @@ -18306,9 +19378,9 @@ paths: description: Response content: application/json: - schema: *125 + schema: *141 examples: - default: *128 + default: *143 '403': *27 '404': *6 x-github: @@ -18330,9 +19402,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - *39 - - *127 + - *137 responses: - '204': *129 + '204': *139 '403': *27 '404': *6 x-github: @@ -18372,7 +19444,7 @@ paths: - push - repository default: branch - enforcement: &136 + enforcement: &152 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights @@ -18385,7 +19457,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &137 + items: &153 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -18427,7 +19499,7 @@ paths: - pull_request - exempt default: always - conditions: &160 + conditions: &176 title: Enterprise ruleset conditions type: object description: Conditions for an enterprise ruleset. The conditions @@ -18441,7 +19513,7 @@ paths: description: Conditions to target organizations by name and all repositories allOf: - - &130 + - &144 title: Repository ruleset conditions for organization names type: object description: Parameters for an organization name condition @@ -18467,7 +19539,7 @@ paths: type: string required: - organization_name - - &133 + - &147 title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -18496,7 +19568,7 @@ paths: is prevented. required: - repository_name - - &132 + - &146 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name condition @@ -18524,8 +19596,8 @@ paths: description: Conditions to target organizations by name and repositories by property allOf: - - *130 - - &135 + - *144 + - &149 title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -18538,7 +19610,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &131 + items: &145 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a repository @@ -18569,16 +19641,16 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *131 + items: *145 required: - repository_property - - *132 + - *146 - type: object title: organization_id_and_repository_name description: Conditions to target organizations by id and all repositories allOf: - - &134 + - &148 title: Repository ruleset conditions for organization IDs type: object description: Parameters for an organization ID condition @@ -18595,25 +19667,80 @@ paths: type: integer required: - organization_id - - *133 - - *132 + - *147 + - *146 - type: object title: organization_id_and_repository_property description: Conditions to target organization by id and repositories by property allOf: - - *134 - - *135 - - *132 + - *148 + - *149 + - *146 + - type: object + title: organization_property_and_repository_name + description: Conditions to target organizations by property and + all repositories + allOf: + - &151 + 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: &150 + 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: *150 + required: + - organization_property + - *147 + - *146 + - type: object + title: organization_property_and_repository_property + description: Conditions to target organizations by property and + repositories by property + allOf: + - *151 + - *149 + - *146 rules: type: array description: An array of rules within the ruleset. - items: &161 + items: &177 title: Repository Rule type: object description: A repository rule. oneOf: - - &138 + - &154 title: creation description: Only allow users with bypass permission to create matching refs. @@ -18625,7 +19752,7 @@ paths: type: string enum: - creation - - &139 + - &155 title: update description: Only allow users with bypass permission to update matching refs. @@ -18646,7 +19773,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &140 + - &156 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -18658,7 +19785,7 @@ paths: type: string enum: - deletion - - &141 + - &157 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -18670,7 +19797,7 @@ paths: type: string enum: - required_linear_history - - &142 + - &158 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches @@ -18694,7 +19821,7 @@ paths: type: string required: - required_deployment_environments - - &143 + - &159 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -18706,7 +19833,7 @@ paths: type: string enum: - required_signatures - - &144 + - &160 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. @@ -18766,7 +19893,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &145 + - &161 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed @@ -18813,7 +19940,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &146 + - &162 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -18825,7 +19952,7 @@ paths: type: string enum: - non_fast_forward - - &147 + - &163 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -18861,7 +19988,7 @@ paths: required: - operator - pattern - - &148 + - &164 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -18897,7 +20024,7 @@ paths: required: - operator - pattern - - &149 + - &165 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -18933,7 +20060,7 @@ paths: required: - operator - pattern - - &150 + - &166 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -18969,7 +20096,7 @@ paths: required: - operator - pattern - - &151 + - &167 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -19005,7 +20132,7 @@ paths: required: - operator - pattern - - &152 + - &168 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. @@ -19029,7 +20156,7 @@ paths: type: string required: - restricted_file_paths - - &153 + - &169 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit @@ -19053,7 +20180,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &154 + - &170 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -19076,7 +20203,7 @@ paths: type: string required: - restricted_file_extensions - - &155 + - &171 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. @@ -19100,7 +20227,7 @@ paths: maximum: 100 required: - max_file_size - - &156 + - &172 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -19149,7 +20276,7 @@ paths: - repository_id required: - workflows - - &157 + - &173 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning @@ -19235,7 +20362,7 @@ paths: description: Response content: application/json: - schema: &158 + schema: &174 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -19270,11 +20397,11 @@ paths: source: type: string description: The name of the source - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 + items: *153 current_user_can_bypass: type: string description: |- @@ -19306,8 +20433,8 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - *132 - - &380 + - *146 + - &397 title: Organization ruleset conditions type: object description: |- @@ -19321,14 +20448,14 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *132 - - *133 + - *146 + - *147 - type: object title: repository_id_and_ref_name description: Conditions to target repositories by id and refs by name allOf: - - *132 + - *146 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -19350,23 +20477,23 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *132 - - *135 + - *146 + - *149 type: - 'null' - object rules: type: array - items: &679 + items: &698 title: Repository Rule type: object description: A repository rule. oneOf: - - *138 - - *139 - - *140 - - *141 - - &676 + - *154 + - *155 + - *156 + - *157 + - &695 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -19444,23 +20571,23 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - *142 - - *143 - - *144 - - *145 - - *146 - - *147 - - *148 - - *149 - - *150 - - *151 - - *152 - - *153 - - *154 - - *155 - - *156 - - *157 - - &677 + - *158 + - *159 + - *160 + - *161 + - *162 + - *163 + - *164 + - *165 + - *166 + - *167 + - *168 + - *169 + - *170 + - *171 + - *172 + - *173 + - &696 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -19490,7 +20617,7 @@ paths: type: string format: date-time examples: - default: &159 + default: &175 value: id: 21 name: super cool ruleset @@ -19549,9 +20676,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *159 + default: *175 '404': *6 '500': *38 x-github: @@ -19595,16 +20722,16 @@ paths: - tag - push - repository - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 - conditions: *160 + items: *153 + conditions: *176 rules: description: An array of rules within the ruleset. type: array - items: *161 + items: *177 examples: default: value: @@ -19628,9 +20755,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *159 + default: *175 '404': *6 '500': *38 x-github: @@ -19692,7 +20819,7 @@ paths: application/json: schema: type: array - items: &162 + items: &178 title: Ruleset version type: object description: The historical version of a ruleset @@ -19716,7 +20843,7 @@ paths: type: string format: date-time examples: - default: &383 + default: &400 value: - version_id: 3 actor: @@ -19769,9 +20896,9 @@ paths: description: Response content: application/json: - schema: &384 + schema: &401 allOf: - - *162 + - *178 - type: object required: - state @@ -19824,7 +20951,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *39 - - &385 + - &402 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -19835,7 +20962,7 @@ paths: enum: - open - resolved - - &386 + - &403 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -19845,7 +20972,7 @@ paths: required: false schema: type: string - - &387 + - &404 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -19854,7 +20981,7 @@ paths: required: false schema: type: string - - &388 + - &405 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. @@ -19866,11 +20993,11 @@ paths: - created - updated default: created - - *99 + - *104 - *17 - - *97 - - *98 - - &389 + - *102 + - *103 + - &406 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -19879,7 +21006,7 @@ paths: required: false schema: type: string - - &390 + - &407 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -19888,7 +21015,7 @@ paths: schema: type: boolean default: false - - &391 + - &408 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -19897,7 +21024,7 @@ paths: schema: type: boolean default: false - - &392 + - &409 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -19913,30 +21040,30 @@ paths: application/json: schema: type: array - items: &393 + items: &410 type: object properties: - number: *109 - created_at: *116 + number: *119 + created_at: *126 updated_at: anyOf: - type: 'null' - - *117 - url: *114 - html_url: *115 + - *127 + url: *124 + html_url: *125 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &691 + state: &710 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: &692 + resolution: &711 type: - string - 'null' @@ -19970,7 +21097,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *108 + repository: *113 push_protection_bypassed: type: - boolean @@ -20043,14 +21170,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &693 + - &712 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &695 + - &714 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -20107,7 +21234,7 @@ paths: - blob_url - commit_sha - commit_url - - &696 + - &715 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. @@ -20168,7 +21295,7 @@ paths: - page_url - commit_sha - commit_url - - &697 + - &716 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -20183,7 +21310,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &698 + - &717 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -20198,7 +21325,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &699 + - &718 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -20213,7 +21340,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &700 + - &719 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -20228,7 +21355,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &701 + - &720 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -20243,7 +21370,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &702 + - &721 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -20258,7 +21385,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &703 + - &722 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. @@ -20273,7 +21400,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &704 + - &723 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. @@ -20288,7 +21415,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &705 + - &724 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. @@ -20303,7 +21430,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &706 + - &725 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. @@ -20318,7 +21445,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &707 + - &726 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 @@ -20343,7 +21470,7 @@ paths: - type: 'null' - *4 examples: - default: &394 + default: &411 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -20521,9 +21648,9 @@ paths: headers: Link: *41 '404': *6 - '503': *163 + '503': *179 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning @@ -20552,13 +21679,13 @@ paths: description: Response content: application/json: - schema: &395 + schema: &412 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: &165 + pattern_config_version: &181 type: - string - 'null' @@ -20568,7 +21695,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &164 + items: &180 type: object properties: token_type: @@ -20637,9 +21764,9 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *164 + items: *180 examples: - default: &396 + default: &413 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -20694,7 +21821,7 @@ paths: schema: type: object properties: - pattern_config_version: *165 + pattern_config_version: *181 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -20720,7 +21847,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *165 + custom_pattern_version: *181 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -20756,7 +21883,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 "/enterprises/{enterprise}/settings/billing/actions": get: @@ -20783,7 +21910,7 @@ paths: description: Response content: application/json: - schema: &398 + schema: &415 type: object properties: total_minutes_used: @@ -20853,7 +21980,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &399 + default: &416 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -20884,7 +22011,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &400 + - &417 name: advanced_security_product in: query description: | @@ -20904,7 +22031,7 @@ paths: description: Success content: application/json: - schema: &401 + schema: &418 type: object properties: total_advanced_security_committers: @@ -20967,7 +22094,7 @@ paths: required: - repositories examples: - default: &402 + default: &419 value: total_advanced_security_committers: 2 total_count: 2 @@ -21006,6 +22133,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise parameters: - *39 + - 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 @@ -21078,7 +22215,7 @@ paths: '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21208,7 +22345,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - *39 - - &168 + - &184 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -21220,7 +22357,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &166 + schema: &182 type: object properties: id: @@ -21260,7 +22397,7 @@ paths: - name - resources examples: - default: &167 + default: &183 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -21274,7 +22411,7 @@ paths: '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21324,15 +22461,15 @@ paths: description: Response when updating a cost center content: application/json: - schema: *166 + schema: *182 examples: - default: *167 + default: *183 '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21350,7 +22487,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - *39 - - *168 + - *184 responses: '200': description: Response when deleting a cost center @@ -21389,7 +22526,7 @@ paths: '404': *6 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21410,7 +22547,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - *39 - - *168 + - *184 requestBody: required: true content: @@ -21481,9 +22618,9 @@ paths: previous_cost_center: yet-another-cost-center '400': *14 '403': *27 - '409': *107 + '409': *112 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21503,7 +22640,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - *39 - - *168 + - *184 requestBody: required: true content: @@ -21550,7 +22687,7 @@ paths: '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21581,7 +22718,7 @@ paths: description: Response content: application/json: - schema: &403 + schema: &420 type: object properties: total_gigabytes_bandwidth_used: @@ -21599,7 +22736,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &404 + default: &421 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -21612,8 +22749,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 @@ -21622,7 +22761,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *39 - - &169 + - &185 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, @@ -21631,7 +22770,7 @@ paths: required: false schema: type: integer - - &213 + - &231 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 @@ -21640,7 +22779,7 @@ paths: required: false schema: type: integer - - &170 + - &186 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 @@ -21656,21 +22795,21 @@ paths: required: false schema: type: string - - &214 + - &232 name: user description: The user name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &215 + - &233 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &216 + - &234 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -21754,19 +22893,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 @@ -21809,7 +22948,7 @@ paths: '403': *27 '404': *6 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21840,7 +22979,7 @@ paths: description: Response content: application/json: - schema: &405 + schema: &422 type: object properties: days_left_in_billing_cycle: @@ -21858,7 +22997,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &406 + default: &423 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -21883,8 +23022,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *39 - - *169 - - &217 + - *185 + - &235 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 @@ -21893,8 +23032,8 @@ paths: required: false schema: type: integer - - *170 - - &218 + - *186 + - &236 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 @@ -21915,7 +23054,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &219 + schema: &237 type: object properties: usageItems: @@ -21968,7 +23107,7 @@ paths: - netAmount - organizationName examples: - default: &220 + default: &238 value: usageItems: - date: '2023-08-01' @@ -21985,7 +23124,7 @@ paths: '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -22056,13 +23195,13 @@ paths: application/json: schema: type: array - items: *171 + items: *187 examples: - default: *172 + default: *188 '500': *38 '403': *27 '404': *6 - '422': *173 + '422': *189 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -22089,9 +23228,9 @@ paths: application/json: schema: type: array - items: *174 + items: *190 examples: - default: &175 + default: &191 value: - id: 1 name: Justice League @@ -22148,6 +23287,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: type: - string @@ -22167,9 +23318,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *190 examples: - default: *175 + default: *191 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22187,7 +23338,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *39 - - &176 + - &192 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -22206,7 +23357,7 @@ paths: type: array items: *4 examples: - default: &177 + default: &193 value: - login: octocat id: 1 @@ -22245,7 +23396,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *39 - - *176 + - *192 requestBody: required: true content: @@ -22276,7 +23427,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22294,7 +23445,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *39 - - *176 + - *192 requestBody: required: true content: @@ -22325,7 +23476,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22343,8 +23494,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *39 - - *176 - - *178 + - *192 + - *194 responses: '200': description: User is a member of the enterprise team. @@ -22352,7 +23503,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &179 + exampleKey1: &195 value: login: octocat id: 1 @@ -22388,8 +23539,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *39 - - *176 - - *178 + - *192 + - *194 responses: '201': description: Successfully added team member @@ -22397,7 +23548,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *179 + exampleKey1: *195 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22415,8 +23566,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *39 - - *176 - - *178 + - *192 + - *194 responses: '204': description: Response @@ -22426,6 +23577,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: + - *39 + - *192 + - *17 + - *19 + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: *67 + examples: + default: &196 + 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: + - *39 + - *192 + 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: *67 + examples: + default: &230 + 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: + - *39 + - *192 + 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: + - *39 + - *192 + - *81 + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: *67 + examples: + default: *196 + '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: + - *39 + - *192 + - *81 + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: *67 + examples: + default: *196 + 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: + - *39 + - *192 + - *81 + 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 @@ -22441,7 +23813,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *39 - - &180 + - &197 name: team_slug description: The slug of the team name. in: path @@ -22453,9 +23825,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *190 examples: - default: *175 + default: *191 headers: Link: *41 '403': *27 @@ -22475,7 +23847,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *39 - - *180 + - *197 requestBody: required: true content: @@ -22503,6 +23875,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: type: - string @@ -22521,9 +23905,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *190 examples: - default: *175 + default: *191 headers: Link: *41 '403': *27 @@ -22546,7 +23930,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *39 - - *180 + - *197 responses: '204': description: Response @@ -22645,7 +24029,7 @@ paths: application/json: schema: type: array - items: &208 + items: &225 title: Event description: Event type: object @@ -22656,7 +24040,7 @@ paths: type: - string - 'null' - actor: &181 + actor: &198 title: Actor description: Actor type: object @@ -22697,7 +24081,7 @@ paths: - id - name - url - org: *181 + org: *198 payload: oneOf: - title: CreateEvent @@ -22744,7 +24128,7 @@ paths: properties: action: type: string - discussion: &829 + discussion: &847 title: Discussion description: A Discussion in a repository. type: object @@ -23041,7 +24425,7 @@ paths: - id labels: type: array - items: &182 + items: &199 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -23124,7 +24508,7 @@ paths: properties: action: type: string - issue: &183 + issue: &200 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -23247,7 +24631,7 @@ paths: milestone: anyOf: - type: 'null' - - &368 + - &386 title: Milestone description: A collection of related issues and pull requests. @@ -23419,7 +24803,7 @@ paths: timeline_url: type: string format: uri - type: &331 + type: &349 title: Issue Type description: The type of issue. type: @@ -23473,12 +24857,12 @@ paths: - node_id - name - description - repository: *67 + repository: *72 performed_via_github_app: anyOf: - type: 'null' - *5 - author_association: &184 + author_association: &201 title: author_association type: string description: How the author is associated with the @@ -23494,7 +24878,7 @@ paths: - OWNER examples: - OWNER - reactions: &185 + reactions: &202 title: Reaction Rollup type: object properties: @@ -23530,7 +24914,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &751 + sub_issues_summary: &770 title: Sub-issues Summary type: object properties: @@ -23551,7 +24935,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &752 + issue_dependencies_summary: &771 title: Issue Dependencies Summary type: object properties: @@ -23570,7 +24954,7 @@ paths: - total_blocking issue_field_values: type: array - items: &753 + items: &772 title: Issue Field Value description: A value assigned to an issue field type: object @@ -23670,10 +25054,10 @@ paths: assignees: type: array items: *4 - label: *182 + label: *199 labels: type: array - items: *182 + items: *199 required: - action - issue @@ -23682,8 +25066,8 @@ paths: properties: action: type: string - issue: *183 - comment: &617 + issue: *200 + comment: &634 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -23733,12 +25117,12 @@ paths: issue_url: type: string format: uri - author_association: *184 + author_association: *201 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *185 + reactions: *202 required: - id - node_id @@ -23917,7 +25301,7 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 allow_forking: type: boolean is_template: @@ -24008,7 +25392,7 @@ paths: type: string number: type: integer - pull_request: &187 + pull_request: &204 title: Pull Request Minimal type: object properties: @@ -24079,10 +25463,10 @@ paths: assignees: type: array items: *4 - label: *182 + label: *199 labels: type: array - items: *182 + items: *199 required: - action - number @@ -24092,7 +25476,7 @@ paths: properties: action: type: string - pull_request: *187 + pull_request: *204 comment: type: object properties: @@ -24346,7 +25730,7 @@ paths: - pull_request updated_at: type: string - pull_request: *187 + pull_request: *204 required: - action - review @@ -24395,7 +25779,7 @@ paths: updated_at: type: string format: date-time - reactions: *185 + reactions: *202 required: - action - comment @@ -24406,7 +25790,7 @@ paths: type: string release: allOf: - - &669 + - &688 title: Release description: A release. type: object @@ -24488,7 +25872,7 @@ paths: author: *4 assets: type: array - items: &670 + items: &689 title: Release Asset description: Data related to a release. type: object @@ -24563,7 +25947,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *185 + reactions: *202 required: - assets_url - upload_url @@ -24656,7 +26040,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24746,7 +26130,7 @@ paths: _links: type: object properties: - timeline: &188 + timeline: &205 title: Link With Type description: Hypermedia Link with Type type: object @@ -24758,17 +26142,17 @@ paths: required: - href - type - user: *188 - security_advisories: *188 - current_user: *188 - current_user_public: *188 - current_user_actor: *188 - current_user_organization: *188 + user: *205 + security_advisories: *205 + current_user: *205 + current_user_public: *205 + current_user_actor: *205 + current_user_organization: *205 current_user_organizations: type: array - items: *188 - repository_discussions: *188 - repository_discussions_category: *188 + items: *205 + repository_discussions: *205 + repository_discussions_category: *205 required: - timeline - user @@ -24830,7 +26214,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *189 + - *206 - *17 - *19 responses: @@ -24840,7 +26224,7 @@ paths: application/json: schema: type: array - items: &190 + items: &207 title: Base Gist description: Base Gist type: object @@ -24937,7 +26321,7 @@ paths: - created_at - updated_at examples: - default: &191 + default: &208 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -25061,7 +26445,7 @@ paths: description: Response content: application/json: - schema: &192 + schema: &209 title: Gist Simple description: Gist Simple type: object @@ -25079,7 +26463,7 @@ paths: url: type: string format: uri - user: &765 + user: &784 title: Public User description: Public User type: object @@ -25453,7 +26837,7 @@ paths: truncated: type: boolean examples: - default: &193 + default: &210 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -25557,7 +26941,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *189 + - *206 - *17 - *19 responses: @@ -25567,9 +26951,9 @@ paths: application/json: schema: type: array - items: *190 + items: *207 examples: - default: *191 + default: *208 headers: Link: *41 '422': *15 @@ -25591,7 +26975,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *189 + - *206 - *17 - *19 responses: @@ -25601,9 +26985,9 @@ paths: application/json: schema: type: array - items: *190 + items: *207 examples: - default: *191 + default: *208 headers: Link: *41 '401': *23 @@ -25631,7 +27015,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &194 + - &211 name: gist_id description: The unique identifier of the gist. in: path @@ -25643,10 +27027,10 @@ paths: description: Response content: application/json: - schema: *192 + schema: *209 examples: - default: *193 - '403': &197 + default: *210 + '403': &214 description: Forbidden Gist content: application/json: @@ -25695,7 +27079,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *194 + - *211 requestBody: required: true content: @@ -25759,9 +27143,9 @@ paths: description: Response content: application/json: - schema: *192 + schema: *209 examples: - updateGist: *193 + updateGist: *210 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -25919,7 +27303,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *194 + - *211 responses: '204': description: Response @@ -25948,7 +27332,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *194 + - *211 - *17 - *19 responses: @@ -25958,7 +27342,7 @@ paths: application/json: schema: type: array - items: &195 + items: &212 title: Gist Comment description: A comment made to a gist. type: object @@ -25996,7 +27380,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *184 + author_association: *201 required: - url - id @@ -26061,7 +27445,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *194 + - *211 requestBody: required: true content: @@ -26087,9 +27471,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *212 examples: - default: &196 + default: &213 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -26147,8 +27531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *194 - - &198 + - *211 + - &215 name: comment_id description: The unique identifier of the comment. in: path @@ -26161,12 +27545,12 @@ paths: description: Response content: application/json: - schema: *195 + schema: *212 examples: - default: *196 + default: *213 '304': *35 '404': *6 - '403': *197 + '403': *214 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26188,8 +27572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *194 - - *198 + - *211 + - *215 requestBody: required: true content: @@ -26215,9 +27599,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *212 examples: - default: *196 + default: *213 '404': *6 x-github: githubCloudOnly: false @@ -26234,8 +27618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *194 - - *198 + - *211 + - *215 responses: '204': description: Response @@ -26258,7 +27642,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *194 + - *211 - *17 - *19 responses: @@ -26359,7 +27743,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *194 + - *211 - *17 - *19 responses: @@ -26369,7 +27753,7 @@ paths: application/json: schema: type: array - items: *192 + items: *209 examples: default: value: @@ -26434,13 +27818,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *194 + - *211 responses: '201': description: Response content: application/json: - schema: *190 + schema: *207 examples: default: value: @@ -26511,7 +27895,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *194 + - *211 responses: '204': description: Response if gist is starred @@ -26541,7 +27925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *194 + - *211 responses: '204': description: Response @@ -26563,7 +27947,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *194 + - *211 responses: '204': description: Response @@ -26592,7 +27976,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *194 + - *211 - name: sha in: path required: true @@ -26603,9 +27987,9 @@ paths: description: Response content: application/json: - schema: *192 + schema: *209 examples: - default: *193 + default: *210 '422': *15 '404': *6 '403': *27 @@ -26766,7 +28150,7 @@ paths: type: integer repositories: type: array - items: *67 + items: *72 repository_selection: type: string examples: @@ -26974,7 +28358,7 @@ paths: - closed - all default: open - - &334 + - &352 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -26992,8 +28376,8 @@ paths: - updated - comments default: created - - *99 - - *189 + - *104 + - *206 - name: collab in: query required: false @@ -27023,9 +28407,9 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: &335 + default: &353 value: - id: 1 node_id: MDU6SXNzdWUx @@ -27305,7 +28689,7 @@ paths: application/json: schema: type: array - items: *186 + items: *203 examples: default: value: @@ -27603,7 +28987,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &199 + X-CommonMarker-Version: &216 example: 0.17.4 schema: type: string @@ -27658,7 +29042,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *199 + X-CommonMarker-Version: *216 content: text/html: schema: @@ -27687,7 +29071,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: - - &202 + - &219 name: account_id description: account_id parameter in: path @@ -27699,7 +29083,7 @@ paths: description: Response content: application/json: - schema: &201 + schema: &218 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -27733,7 +29117,7 @@ paths: - 'null' id: type: integer - plan: &200 + plan: &217 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -27836,7 +29220,7 @@ paths: - 'null' updated_at: type: string - plan: *200 + plan: *217 required: - url - id @@ -27844,7 +29228,7 @@ paths: - login - marketplace_purchase examples: - default: &203 + default: &220 value: url: https://api.github.com/orgs/github type: Organization @@ -27929,9 +29313,9 @@ paths: application/json: schema: type: array - items: *200 + items: *217 examples: - default: &204 + default: &221 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -27971,14 +29355,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &205 + - &222 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &206 + - &223 name: sort description: The property to sort the results by. in: query @@ -28008,9 +29392,9 @@ paths: application/json: schema: type: array - items: *201 + items: *218 examples: - default: &207 + default: &224 value: - url: https://api.github.com/orgs/github type: Organization @@ -28084,15 +29468,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: - - *202 + - *219 responses: '200': description: Response content: application/json: - schema: *201 + schema: *218 examples: - default: *203 + default: *220 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -28124,9 +29508,9 @@ paths: application/json: schema: type: array - items: *200 + items: *217 examples: - default: *204 + default: *221 headers: Link: *41 '401': *23 @@ -28149,8 +29533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *205 - - *206 + - *222 + - *223 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -28170,9 +29554,9 @@ paths: application/json: schema: type: array - items: *201 + items: *218 examples: - default: *207 + default: *224 headers: Link: *41 '401': *23 @@ -28437,14 +29821,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: - - &430 + - &447 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &431 + - &448 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -28461,7 +29845,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -28506,7 +29890,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &444 + '301': &461 description: Moved permanently content: application/json: @@ -28528,7 +29912,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &645 + - &662 name: all description: If `true`, show notifications marked as read. in: query @@ -28536,7 +29920,7 @@ paths: schema: type: boolean default: false - - &646 + - &663 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -28545,8 +29929,8 @@ paths: schema: type: boolean default: false - - *189 - - &647 + - *206 + - &664 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: @@ -28571,14 +29955,14 @@ paths: application/json: schema: type: array - items: &209 + items: &226 title: Thread description: Thread type: object properties: id: type: string - repository: &246 + repository: &266 title: Minimal Repository description: Minimal Repository type: object @@ -28917,7 +30301,7 @@ paths: type: boolean examples: - false - security_and_analysis: &377 + security_and_analysis: &394 type: - object - 'null' @@ -29090,7 +30474,7 @@ paths: - url - subscription_url examples: - default: &648 + default: &665 value: - id: '1' repository: @@ -29256,7 +30640,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &210 + - &227 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 @@ -29270,7 +30654,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *226 examples: default: value: @@ -29373,7 +30757,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *210 + - *227 responses: '205': description: Reset Content @@ -29396,7 +30780,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *210 + - *227 responses: '204': description: No content @@ -29419,13 +30803,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: - - *210 + - *227 responses: '200': description: Response content: application/json: - schema: &211 + schema: &228 title: Thread Subscription description: Thread Subscription type: object @@ -29469,7 +30853,7 @@ paths: - url - subscribed examples: - default: &212 + default: &229 value: subscribed: true ignored: false @@ -29500,7 +30884,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *210 + - *227 requestBody: required: false content: @@ -29521,9 +30905,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *228 examples: - default: *212 + default: *229 '304': *35 '403': *27 '401': *23 @@ -29546,7 +30930,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *210 + - *227 responses: '204': description: Response @@ -29641,22 +31025,9 @@ paths: application/json: schema: type: array - items: *62 + items: *67 examples: - default: &781 - 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: *230 headers: Link: example: ; rel="next" @@ -29708,7 +31079,7 @@ paths: - 3 custom_roles: type: array - items: &289 + items: &309 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -29757,7 +31128,7 @@ paths: - created_at - updated_at examples: - default: &290 + default: &310 value: id: 8030 name: Security Engineer @@ -29804,7 +31175,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: - - *76 + - *81 - name: page in: query description: The page number of results to fetch. @@ -29850,7 +31221,7 @@ paths: items: anyOf: - type: 'null' - - *108 + - *113 additionalProperties: false examples: default: @@ -29955,7 +31326,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: - - *76 + - *81 requestBody: required: true content: @@ -30021,7 +31392,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: - - *76 + - *81 requestBody: required: true content: @@ -30055,12 +31426,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: + - *81 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *140 + examples: + default: &671 + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + '403': *27 + '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: + - *81 + 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: *140 + required: + - properties + examples: + default: &672 + 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': *27 + '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 @@ -30068,13 +31540,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: - - *76 - - *169 - - *213 - - *170 - - *214 - - *215 - - *216 + - *81 + - *185 + - *231 + - *186 + - *232 + - *233 + - *234 responses: '200': description: Response when getting a billing premium request usage report @@ -30130,19 +31602,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 @@ -30185,7 +31657,7 @@ paths: '403': *27 '404': *6 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30205,23 +31677,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: - - *76 - - *169 - - *217 - - *170 - - *218 + - *81 + - *185 + - *235 + - *186 + - *236 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *219 + schema: *237 examples: - default: *220 + default: *238 '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30247,13 +31719,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: &221 + schema: &239 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -30663,7 +32135,7 @@ paths: - updated_at - archived_at examples: - default-response: &222 + default-response: &240 value: login: github id: 1 @@ -30765,7 +32237,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *76 + - *81 requestBody: required: false content: @@ -30989,18 +32461,18 @@ paths: description: Response content: application/json: - schema: *221 + schema: *239 examples: - default: *222 + default: *240 '422': description: Validation failed content: application/json: schema: oneOf: - - *223 - - *224 - '409': *107 + - *241 + - *242 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31023,7 +32495,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *76 + - *81 responses: '202': *37 '404': *6 @@ -31048,15 +32520,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *225 + schema: *243 examples: - default: *226 + default: *244 headers: Link: *41 x-github: @@ -31079,7 +32551,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: - - *76 + - *81 - *17 - *19 responses: @@ -31097,7 +32569,7 @@ paths: type: integer repository_cache_usages: type: array - items: &449 + items: &466 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -31155,7 +32627,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: - - *76 + - *81 - *17 - *19 responses: @@ -31175,7 +32647,7 @@ paths: type: array items: *42 examples: - default: *227 + default: *245 headers: Link: *41 x-github: @@ -31195,7 +32667,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: - - *76 + - *81 requestBody: required: true content: @@ -31224,6 +32696,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -31241,6 +32719,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 @@ -31264,10 +32747,193 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 + 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: + - *81 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: *43 + examples: + default: *45 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: + - *81 + - *44 + responses: + '200': + description: Response + content: + application/json: + schema: *43 + examples: + default: *246 + 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: + - *81 + - *44 + 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: + - *44 + - *81 + 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: *46 + examples: + default: *45 + 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: + - *81 + - *44 + - *47 + responses: + '200': + description: Response + content: + application/json: + schema: *46 + examples: + default: *247 + 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: + - *81 + - *44 + - *47 + responses: + '204': + description: Response + x-github: githubCloudOnly: false + enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": @@ -31282,7 +32948,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: - - *76 + - *81 responses: '200': description: Response @@ -31298,9 +32964,9 @@ paths: type: integer images: type: array - items: *43 + items: *48 examples: - default: *44 + default: *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31318,7 +32984,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: - - *76 + - *81 responses: '200': description: Response @@ -31334,9 +33000,9 @@ paths: type: integer images: type: array - items: *43 + items: *48 examples: - default: *44 + default: *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31353,15 +33019,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *228 + schema: *248 examples: - default: *229 + default: *249 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31379,7 +33045,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: - - *76 + - *81 responses: '200': description: Response @@ -31395,9 +33061,9 @@ paths: type: integer machine_specs: type: array - items: *45 + items: *50 examples: - default: *230 + default: *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31415,7 +33081,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: - - *76 + - *81 responses: '200': description: Response @@ -31459,8 +33125,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: - - *76 - - *47 + - *81 + - *52 responses: '200': description: Response @@ -31468,7 +33134,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 headers: Link: *41 x-github: @@ -31488,8 +33154,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: - - *76 - - *47 + - *81 + - *52 requestBody: required: true content: @@ -31515,6 +33181,12 @@ 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 + - 'null' examples: default: value: @@ -31529,7 +33201,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -31545,8 +33217,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: - - *76 - - *47 + - *81 + - *52 responses: '202': description: Response @@ -31554,7 +33226,7 @@ paths: application/json: schema: *42 examples: - default: *46 + default: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -31574,13 +33246,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: - - *76 + - *81 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &231 + schema: &251 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -31594,7 +33266,7 @@ paths: required: - include_claim_keys examples: - default: &232 + default: &252 value: include_claim_keys: - repo @@ -31616,20 +33288,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: - - *76 + - *81 requestBody: required: true content: application/json: - schema: *231 + schema: *251 examples: - default: *232 + default: *252 responses: '201': description: Empty response content: application/json: - schema: &257 + schema: &277 title: Empty Object description: An object without any properties. type: object @@ -31659,7 +33331,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: - - *76 + - *81 responses: '200': description: Response @@ -31668,7 +33340,7 @@ paths: schema: type: object properties: - enabled_repositories: &234 + enabled_repositories: &254 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -31681,9 +33353,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: *49 - selected_actions_url: *233 - sha_pinning_required: *50 + allowed_actions: *54 + selected_actions_url: *253 + sha_pinning_required: *55 required: - enabled_repositories examples: @@ -31713,7 +33385,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: - - *76 + - *81 responses: '204': description: Response @@ -31724,9 +33396,9 @@ paths: schema: type: object properties: - enabled_repositories: *234 - allowed_actions: *49 - sha_pinning_required: *50 + enabled_repositories: *254 + allowed_actions: *54 + sha_pinning_required: *55 required: - enabled_repositories examples: @@ -31754,13 +33426,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *235 + schema: *255 examples: response: summary: Example response @@ -31786,12 +33458,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: - - *76 + - *81 requestBody: required: true content: application/json: - schema: *236 + schema: *256 examples: application/json: value: @@ -31801,7 +33473,7 @@ paths: description: No content '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 x-github: enabledForGitHubApps: true @@ -31821,15 +33493,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *51 + schema: *56 examples: - default: *237 + default: *257 '404': *6 x-github: enabledForGitHubApps: true @@ -31848,7 +33520,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: - - *76 + - *81 responses: '204': description: Response @@ -31858,7 +33530,7 @@ paths: required: true content: application/json: - schema: *51 + schema: *56 examples: default: summary: Set approval policy to first time contributors @@ -31880,15 +33552,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *238 + schema: *258 examples: - default: *52 + default: *57 '403': *27 '404': *6 x-github: @@ -31906,14 +33578,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: - - *76 + - *81 requestBody: required: true content: application/json: - schema: *239 + schema: *259 examples: - default: *52 + default: *57 responses: '204': description: Empty response for successful settings update @@ -31943,7 +33615,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: - - *76 + - *81 - *17 - *19 responses: @@ -31961,9 +33633,9 @@ paths: type: number repositories: type: array - items: *67 + items: *72 examples: - default: &241 + default: &261 value: total_count: 1 repositories: @@ -32103,7 +33775,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: - - *76 + - *81 responses: '204': description: Response @@ -32147,8 +33819,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: - - *76 - - &240 + - *81 + - &260 name: repository_id description: The unique identifier of the repository. in: path @@ -32176,8 +33848,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: - - *76 - - *240 + - *81 + - *260 responses: '204': description: Response @@ -32200,15 +33872,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *54 + schema: *59 examples: - default: *55 + default: *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32231,7 +33903,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: - - *76 + - *81 responses: '204': description: Response @@ -32239,9 +33911,9 @@ paths: required: false content: application/json: - schema: *54 + schema: *59 examples: - selected_actions: *55 + selected_actions: *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32261,7 +33933,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: - - *76 + - *81 responses: '200': description: Response @@ -32309,7 +33981,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: - - *76 + - *81 requestBody: required: true content: @@ -32336,7 +34008,7 @@ paths: description: No content '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 x-github: enabledForGitHubApps: true @@ -32356,7 +34028,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: - - *76 + - *81 - *17 - *19 responses: @@ -32371,9 +34043,9 @@ paths: type: integer repositories: type: array - items: *67 + items: *72 examples: - default: *241 + default: *261 '403': *27 '404': *6 x-github: @@ -32393,7 +34065,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: - - *76 + - *81 requestBody: required: true content: @@ -32441,14 +34113,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: - - *76 - - *240 + - *81 + - *260 responses: '204': description: No content '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 x-github: enabledForGitHubApps: true @@ -32468,14 +34140,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: - - *76 - - *240 + - *81 + - *260 responses: '204': description: No content '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 x-github: enabledForGitHubApps: true @@ -32497,15 +34169,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *242 + schema: *262 examples: - default: *58 + default: *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32526,7 +34198,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: - - *76 + - *81 responses: '204': description: Success response @@ -32537,9 +34209,9 @@ paths: required: false content: application/json: - schema: *243 + schema: *263 examples: - default: *58 + default: *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32559,7 +34231,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: - - *76 + - *81 - *17 - *19 - name: visible_to_repository @@ -32584,7 +34256,7 @@ paths: type: number runner_groups: type: array - items: &244 + items: &264 type: object properties: id: @@ -32701,7 +34373,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: - - *76 + - *81 requestBody: required: true content: @@ -32774,9 +34446,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *264 examples: - default: &245 + default: &265 value: id: 2 name: octo-runner-group @@ -32811,14 +34483,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: - - *76 - - *61 + - *81 + - *66 responses: '200': description: Response content: application/json: - schema: *244 + schema: *264 examples: default: value: @@ -32854,8 +34526,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: - - *76 - - *61 + - *81 + - *66 requestBody: required: true content: @@ -32911,9 +34583,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *264 examples: - default: *245 + default: *265 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32932,8 +34604,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: - - *76 - - *61 + - *81 + - *66 responses: '204': description: Response @@ -32956,8 +34628,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: - - *76 - - *61 + - *81 + - *66 - *17 - *19 responses: @@ -32977,7 +34649,7 @@ paths: type: array items: *42 examples: - default: *227 + default: *245 headers: Link: *41 x-github: @@ -32999,8 +34671,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: - - *76 - - *61 + - *81 + - *66 - *19 - *17 responses: @@ -33018,9 +34690,9 @@ paths: type: number repositories: type: array - items: *246 + items: *266 examples: - default: &768 + default: &787 value: total_count: 1 repositories: @@ -33272,8 +34944,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: - - *76 - - *61 + - *81 + - *66 requestBody: required: true content: @@ -33317,9 +34989,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: - - *76 - - *61 - - *240 + - *81 + - *66 + - *260 responses: '204': description: Response @@ -33341,9 +35013,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: - - *76 - - *61 - - *240 + - *81 + - *66 + - *260 responses: '204': description: Response @@ -33366,8 +35038,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: - - *76 - - *61 + - *81 + - *66 - *17 - *19 responses: @@ -33385,9 +35057,9 @@ paths: type: number runners: type: array - items: *65 + items: *70 examples: - default: *66 + default: *71 headers: Link: *41 x-github: @@ -33408,8 +35080,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: - - *76 - - *61 + - *81 + - *66 requestBody: required: true content: @@ -33453,9 +35125,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: - - *76 - - *61 - - *64 + - *81 + - *66 + - *69 responses: '204': description: Response @@ -33477,9 +35149,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: - - *76 - - *61 - - *64 + - *81 + - *66 + - *69 responses: '204': description: Response @@ -33509,7 +35181,7 @@ paths: in: query schema: type: string - - *76 + - *81 - *17 - *19 responses: @@ -33527,9 +35199,9 @@ paths: type: integer runners: type: array - items: *65 + items: *70 examples: - default: *66 + default: *71 headers: Link: *41 x-github: @@ -33553,7 +35225,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: - - *76 + - *81 responses: '200': description: Response @@ -33561,9 +35233,9 @@ paths: application/json: schema: type: array - items: *247 + items: *267 examples: - default: *248 + default: *268 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33585,7 +35257,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: - - *76 + - *81 requestBody: required: true content: @@ -33628,10 +35300,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *249 + '201': *269 '404': *6 '422': *7 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33659,15 +35331,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: - - *76 + - *81 responses: '201': description: Response content: application/json: - schema: *68 + schema: *73 examples: - default: *250 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33695,15 +35367,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: - - *76 + - *81 responses: '201': description: Response content: application/json: - schema: *68 + schema: *73 examples: - default: *251 + default: *271 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33725,16 +35397,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: - - *76 - - *64 + - *81 + - *69 responses: '200': description: Response content: application/json: - schema: *65 + schema: *70 examples: - default: *252 + default: *272 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33755,8 +35427,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: - - *76 - - *64 + - *81 + - *69 responses: '204': description: Response @@ -33782,10 +35454,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: - - *76 - - *64 + - *81 + - *69 responses: - '200': *70 + '200': *75 '404': *6 x-github: githubCloudOnly: false @@ -33807,8 +35479,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: - - *76 - - *64 + - *81 + - *69 requestBody: required: true content: @@ -33832,7 +35504,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -33856,8 +35528,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: - - *76 - - *64 + - *81 + - *69 requestBody: required: true content: @@ -33882,7 +35554,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -33906,10 +35578,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: - - *76 - - *64 + - *81 + - *69 responses: - '200': *253 + '200': *273 '404': *6 x-github: githubCloudOnly: false @@ -33936,11 +35608,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: - - *76 - - *64 - - *254 + - *81 + - *69 + - *274 responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -33965,7 +35637,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *76 + - *81 - *17 - *19 responses: @@ -33983,7 +35655,7 @@ paths: type: integer secrets: type: array - items: &255 + items: &275 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -34058,13 +35730,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: &469 + schema: &486 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -34099,7 +35771,7 @@ paths: - key_id - key examples: - default: &470 + default: &487 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -34124,8 +35796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *76 - - &256 + - *81 + - &276 name: secret_name description: The name of the secret. in: path @@ -34137,7 +35809,7 @@ paths: description: Response content: application/json: - schema: *255 + schema: *275 examples: default: value: @@ -34167,8 +35839,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -34225,7 +35897,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -34251,8 +35923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 responses: '204': description: Response @@ -34278,8 +35950,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: - - *76 - - *256 + - *81 + - *276 - *19 - *17 responses: @@ -34297,9 +35969,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: &260 + default: &280 value: total_count: 1 repositories: @@ -34391,8 +36063,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: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -34444,8 +36116,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -34478,8 +36150,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -34511,8 +36183,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *76 - - &454 + - *81 + - &471 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)." @@ -34536,7 +36208,7 @@ paths: type: integer variables: type: array - items: &258 + items: &278 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -34626,7 +36298,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *76 + - *81 requestBody: required: true content: @@ -34674,7 +36346,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -34699,8 +36371,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *76 - - &259 + - *81 + - &279 name: name description: The name of the variable. in: path @@ -34712,7 +36384,7 @@ paths: description: Response content: application/json: - schema: *258 + schema: *278 examples: default: value: @@ -34742,8 +36414,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *76 - - *259 + - *81 + - *279 requestBody: required: true content: @@ -34805,8 +36477,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *76 - - *259 + - *81 + - *279 responses: '204': description: Response @@ -34832,8 +36504,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: - - *76 - - *259 + - *81 + - *279 - *19 - *17 responses: @@ -34851,9 +36523,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: *260 + default: *280 '409': description: Response when the visibility of the variable is not set to `selected` @@ -34879,8 +36551,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: - - *76 - - *259 + - *81 + - *279 requestBody: required: true content: @@ -34929,8 +36601,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: - - *76 - - *259 + - *81 + - *279 - name: repository_id in: path required: true @@ -34964,8 +36636,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: - - *76 - - *259 + - *81 + - *279 - name: repository_id in: path required: true @@ -34996,15 +36668,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *75 + schema: *80 examples: - default: *74 + default: *79 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35023,19 +36695,19 @@ paths: required: true content: application/json: - schema: *261 + schema: *281 examples: - default: *74 + default: *79 parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *75 + schema: *80 examples: - default: *74 + default: *79 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35051,7 +36723,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *76 + - *81 responses: '204': description: Response @@ -35074,7 +36746,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *76 + - *81 requestBody: required: true content: @@ -35216,7 +36888,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *76 + - *81 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -35300,9 +36972,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *97 - - *98 - - *76 + - *102 + - *103 + - *81 requestBody: required: true content: @@ -35325,12 +36997,12 @@ paths: required: - subject_digests examples: - default: &796 + default: &814 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &797 + withPredicateType: &815 value: subject_digests: - sha256:abc123 @@ -35389,7 +37061,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &798 + default: &816 value: attestations_subject_digests: - sha256:abc: @@ -35498,7 +37170,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *76 + - *81 requestBody: required: true content: @@ -35563,7 +37235,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *76 + - *81 - name: subject_digest description: Subject Digest in: path @@ -35582,6 +37254,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 + - *102 + - *103 + - *81 + - 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 @@ -35594,7 +37317,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id parameters: - - *76 + - *81 - name: attestation_id description: Attestation ID in: path @@ -35630,9 +37353,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations parameters: - *17 - - *97 - - *98 - - *76 + - *102 + - *103 + - *81 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -35685,7 +37408,7 @@ paths: initiator: type: string examples: - default: &483 + default: &500 value: attestations: - bundle: @@ -35803,7 +37526,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: - - *76 + - *81 - 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). @@ -35811,10 +37534,10 @@ paths: required: false schema: type: string - - *262 - - *263 - - *264 - - *265 + - *282 + - *283 + - *284 + - *285 - *17 responses: '200': @@ -35823,9 +37546,9 @@ paths: application/json: schema: type: array - items: *266 + items: *286 examples: - default: *267 + default: *287 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35842,7 +37565,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *76 + - *81 - *17 - *19 responses: @@ -35854,7 +37577,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35873,8 +37596,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: If the user is blocked @@ -35899,8 +37622,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -35920,8 +37643,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -35947,17 +37670,17 @@ paths: category: orgs subcategory: bypass-requests parameters: - - *76 - - &270 + - *81 + - &290 name: repository_name description: The name of the repository to filter on. in: query schema: type: string - - *92 - - *93 - - *94 - - *95 + - *97 + - *98 + - *99 + - *100 - *17 - *19 responses: @@ -35967,9 +37690,9 @@ paths: application/json: schema: type: array - items: *268 + items: *288 examples: - default: *269 + default: *289 '404': *6 '500': *38 "/orgs/{org}/bypass-requests/secret-scanning": @@ -35992,12 +37715,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *76 - - *270 - - *92 - - *93 - - *94 - - *95 + - *81 + - *290 + - *97 + - *98 + - *99 + - *100 - *17 - *19 responses: @@ -36007,9 +37730,9 @@ paths: application/json: schema: type: array - items: *271 + items: *291 examples: - default: *272 + default: *292 '404': *6 '500': *38 "/orgs/{org}/campaigns": @@ -36028,15 +37751,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *76 + - *81 - *19 - *17 - - *99 + - *104 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &274 + schema: &294 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -36062,7 +37785,7 @@ paths: application/json: schema: type: array - items: &275 + items: &295 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -36093,7 +37816,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *273 + items: *293 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -36112,7 +37835,7 @@ paths: - string - 'null' format: date-time - state: *274 + state: *294 contact_link: description: The contact link of the campaign. type: @@ -36210,7 +37933,7 @@ paths: headers: Link: *41 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36234,7 +37957,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *76 + - *81 requestBody: required: true content: @@ -36281,7 +38004,9 @@ paths: format: uri code_scanning_alerts: description: The code scanning alerts to include in this campaign - type: array + type: + - array + - 'null' minItems: 1 items: type: object @@ -36308,7 +38033,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -36329,9 +38058,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *295 examples: - default: &276 + default: &296 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -36380,7 +38109,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36402,7 +38131,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *76 + - *81 - name: campaign_number description: The campaign number. in: path @@ -36414,16 +38143,16 @@ paths: description: Response content: application/json: - schema: *275 + schema: *295 examples: - default: *276 + default: *296 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36444,7 +38173,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign parameters: - - *76 + - *81 - name: campaign_number description: The campaign number. in: path @@ -36494,7 +38223,7 @@ paths: - string - 'null' format: uri - state: *274 + state: *294 examples: default: value: @@ -36504,9 +38233,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *295 examples: - default: *276 + default: *296 '400': description: Bad Request content: @@ -36518,7 +38247,7 @@ paths: content: application/json: schema: *3 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36539,7 +38268,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *76 + - *81 - name: campaign_number description: The campaign number. in: path @@ -36550,7 +38279,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36572,20 +38301,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: - - *76 - - *277 - - *278 - - *97 - - *98 + - *81 + - *297 + - *298 + - *102 + - *103 - *19 - *17 - - *99 + - *104 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: *279 + schema: *299 - name: sort description: The property by which to sort the results. in: query @@ -36601,7 +38330,7 @@ paths: be returned. in: query required: false - schema: &508 + schema: &525 type: string description: Severity of a code scanning alert. enum: @@ -36619,13 +38348,13 @@ paths: application/json: schema: type: array - items: *280 + items: *300 examples: - default: *281 + default: *301 headers: Link: *41 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36647,7 +38376,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: - - *76 + - *81 - name: target_type in: query description: The target type of the code security configuration @@ -36666,8 +38395,8 @@ paths: schema: type: integer default: 30 - - *97 - - *98 + - *102 + - *103 responses: '200': description: Response @@ -36675,7 +38404,7 @@ paths: application/json: schema: type: array - items: *103 + items: *108 examples: default: value: @@ -36758,7 +38487,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *76 + - *81 requestBody: required: true content: @@ -36836,7 +38565,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *282 + code_scanning_options: *302 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -36845,7 +38574,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *106 + code_scanning_default_setup_options: *111 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -36977,9 +38706,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *103 + schema: *108 examples: - default: *283 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37001,15 +38730,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *284 + schema: *304 examples: - default: *285 + default: *305 '304': *35 '403': *27 '404': *6 @@ -37035,7 +38764,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *76 + - *81 requestBody: required: true content: @@ -37061,11 +38790,11 @@ paths: - 32 - 91 responses: - '204': *129 + '204': *139 '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37087,16 +38816,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *76 - - *105 + - *81 + - *110 responses: '200': description: Response content: application/json: - schema: *103 + schema: *108 examples: - default: *283 + default: *303 '304': *35 '403': *27 '404': *6 @@ -37120,8 +38849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *76 - - *105 + - *81 + - *110 requestBody: required: true content: @@ -37200,7 +38929,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *106 + code_scanning_default_setup_options: *111 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -37318,7 +39047,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *103 + schema: *108 examples: default: value: @@ -37377,14 +39106,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *76 - - *105 + - *81 + - *110 responses: - '204': *129 + '204': *139 '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37408,8 +39137,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *76 - - *105 + - *81 + - *110 requestBody: required: true content: @@ -37472,8 +39201,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: - - *76 - - *105 + - *81 + - *110 requestBody: required: true content: @@ -37513,12 +39242,12 @@ paths: - none - private_and_internal - public - configuration: *103 + configuration: *108 examples: default: value: default_for_new_repos: all - configuration: *283 + configuration: *303 '403': *27 '404': *6 x-github: @@ -37542,8 +39271,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: - - *76 - - *105 + - *81 + - *110 - 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)." @@ -37552,8 +39281,8 @@ paths: schema: type: integer default: 30 - - *97 - - *98 + - *102 + - *103 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -37571,13 +39300,13 @@ paths: application/json: schema: type: array - items: *286 + items: *306 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *287 + repository: *307 '403': *27 '404': *6 x-github: @@ -37601,7 +39330,7 @@ paths: parameters: - *17 - *19 - - *76 + - *81 responses: '200': description: Response @@ -37617,7 +39346,7 @@ paths: type: integer codespaces: type: array - items: &336 + items: &354 type: object title: Codespace description: A codespace. @@ -37648,11 +39377,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *246 + repository: *266 machine: anyOf: - type: 'null' - - &537 + - &554 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -37939,7 +39668,7 @@ paths: - pulls_url - recent_folders examples: - default: &337 + default: &355 value: total_count: 3 codespaces: @@ -38371,7 +40100,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *76 + - *81 deprecated: true requestBody: required: true @@ -38438,7 +40167,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: - - *76 + - *81 deprecated: true requestBody: required: true @@ -38493,7 +40222,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *76 + - *81 requestBody: required: true content: @@ -38545,7 +40274,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *76 + - *81 - *17 - *19 responses: @@ -38563,7 +40292,7 @@ paths: type: integer secrets: type: array - items: &288 + items: &308 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -38604,7 +40333,7 @@ paths: - updated_at - visibility examples: - default: &538 + default: &555 value: total_count: 2 secrets: @@ -38636,13 +40365,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: &539 + schema: &556 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -38677,7 +40406,7 @@ paths: - key_id - key examples: - default: &540 + default: &557 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -38700,16 +40429,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 responses: '200': description: Response content: application/json: - schema: *288 + schema: *308 examples: - default: &542 + default: &559 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -38736,8 +40465,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: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -38792,7 +40521,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -38818,8 +40547,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 responses: '204': description: Response @@ -38844,8 +40573,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: - - *76 - - *256 + - *81 + - *276 - *19 - *17 responses: @@ -38863,9 +40592,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: *260 + default: *280 '404': *6 x-github: githubCloudOnly: false @@ -38887,8 +40616,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: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -38938,8 +40667,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -38972,8 +40701,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -39012,7 +40741,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: - - *76 + - *81 responses: '200': description: OK @@ -39153,7 +40882,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: - - *76 + - *81 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -39176,9 +40905,9 @@ paths: currently being billed. seats: type: array - items: *120 + items: *130 examples: - default: *121 + default: *131 headers: Link: *41 '500': *38 @@ -39214,7 +40943,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: - - *76 + - *81 requestBody: content: application/json: @@ -39292,7 +41021,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: - - *76 + - *81 requestBody: content: application/json: @@ -39372,7 +41101,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: - - *76 + - *81 requestBody: content: application/json: @@ -39449,7 +41178,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: - - *76 + - *81 requestBody: content: application/json: @@ -39530,7 +41259,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: - - *76 + - *81 - 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`). @@ -39562,13 +41291,13 @@ paths: application/json: schema: type: array - items: *171 + items: *187 examples: - default: *172 + default: *188 '500': *38 '403': *27 '404': *6 - '422': *173 + '422': *189 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39590,7 +41319,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: - - *76 + - *81 - *17 - name: page description: Page token @@ -39749,7 +41478,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: - - *76 + - *81 - name: credential_id in: path required: true @@ -39780,7 +41509,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: - - *76 + - *81 responses: '200': description: Response - list of custom role names @@ -39796,7 +41525,7 @@ paths: - 3 custom_roles: type: array - items: *289 + items: *309 examples: default: value: @@ -39883,12 +41612,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *76 + - *81 requestBody: required: true content: application/json: - schema: &292 + schema: &312 type: object properties: name: @@ -39930,9 +41659,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '422': *15 '404': *6 x-github: @@ -39956,8 +41685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *76 - - &291 + - *81 + - &311 name: role_id description: The unique identifier of the role. in: path @@ -39969,9 +41698,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '404': *6 x-github: githubCloudOnly: true @@ -39993,13 +41722,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *76 - - *291 + - *81 + - *311 requestBody: required: true content: application/json: - schema: &293 + schema: &313 type: object properties: name: @@ -40038,9 +41767,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '422': *15 '404': *6 x-github: @@ -40064,8 +41793,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *76 - - *291 + - *81 + - *311 responses: '204': description: Response @@ -40093,12 +41822,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: - - *76 + - *81 requestBody: required: true content: application/json: - schema: *292 + schema: *312 examples: default: value: @@ -40112,9 +41841,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '422': *15 '404': *6 x-github: @@ -40144,16 +41873,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: - - *76 - - *291 + - *81 + - *311 responses: '200': description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '404': *6 x-github: githubCloudOnly: true @@ -40181,13 +41910,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: - - *76 - - *291 + - *81 + - *311 requestBody: required: true content: application/json: - schema: *293 + schema: *313 examples: default: value: @@ -40202,9 +41931,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *309 examples: - default: *290 + default: *310 '422': *15 '404': *6 x-github: @@ -40234,8 +41963,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: - - *76 - - *291 + - *81 + - *311 responses: '204': description: Response @@ -40263,12 +41992,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *76 - - *294 - - *295 - - *296 - - *297 - - *298 + - *81 + - *314 + - *315 + - *316 + - *317 + - *318 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -40306,13 +42035,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *299 - - *300 - - *99 - - *97 - - *98 - - *301 - - *302 + - *319 + - *320 + - *104 + - *102 + - *103 - *17 responses: '200': @@ -40321,9 +42048,9 @@ paths: application/json: schema: type: array - items: *303 + items: *321 examples: - default: *304 + default: *322 '304': *35 '400': *14 '403': *27 @@ -40349,7 +42076,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *76 + - *81 - *17 - *19 responses: @@ -40367,7 +42094,7 @@ paths: type: integer secrets: type: array - items: &305 + items: &323 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -40440,13 +42167,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: &565 + schema: &582 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -40465,7 +42192,7 @@ paths: - key_id - key examples: - default: &566 + default: &583 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -40488,14 +42215,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 responses: '200': description: Response content: application/json: - schema: *305 + schema: *323 examples: default: value: @@ -40523,8 +42250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -40583,7 +42310,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -40607,8 +42334,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *76 - - *256 + - *81 + - *276 responses: '204': description: Response @@ -40632,8 +42359,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: - - *76 - - *256 + - *81 + - *276 - *19 - *17 responses: @@ -40651,9 +42378,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: *260 + default: *280 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40674,8 +42401,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: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -40725,8 +42452,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -40757,8 +42484,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: - - *76 - - *256 + - *81 + - *276 - name: repository_id in: path required: true @@ -40794,8 +42521,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *76 - - &574 + - *81 + - &591 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -40803,7 +42530,7 @@ paths: required: false schema: type: string - - &575 + - &592 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -40811,7 +42538,7 @@ paths: required: false schema: type: string - - &576 + - &593 name: time_period description: |- The time period to filter by. @@ -40827,7 +42554,7 @@ paths: - week - month default: month - - &577 + - &594 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -40842,7 +42569,7 @@ paths: - denied - all default: all - - *270 + - *290 - *17 - *19 responses: @@ -40852,7 +42579,7 @@ paths: application/json: schema: type: array - items: &578 + items: &595 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -41015,7 +42742,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &579 + default: &596 value: - id: 21 number: 42 @@ -41101,12 +42828,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *76 - - *270 - - *92 - - *93 - - *94 - - &580 + - *81 + - *290 + - *97 + - *98 + - *99 + - &597 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -41132,7 +42859,7 @@ paths: application/json: schema: type: array - items: &581 + items: &598 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -41246,7 +42973,7 @@ paths: - array - 'null' description: The responses to the dismissal request. - items: *96 + items: *101 url: type: string format: uri @@ -41259,7 +42986,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &582 + default: &599 value: - id: 21 number: 42 @@ -41339,7 +43066,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: - - *76 + - *81 responses: '200': description: Response @@ -41347,7 +43074,7 @@ paths: application/json: schema: type: array - items: &346 + items: &364 title: Package description: A software package type: object @@ -41400,7 +43127,7 @@ paths: repository: anyOf: - type: 'null' - - *246 + - *266 created_at: type: string format: date-time @@ -41418,7 +43145,7 @@ paths: - created_at - updated_at examples: - default: &347 + default: &365 value: - id: 197 name: hello_docker @@ -41496,7 +43223,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *76 + - *81 - *17 - *19 responses: @@ -41506,7 +43233,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: 200-response: value: @@ -41579,7 +43306,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *76 + - *81 - name: group_id description: The unique identifier of the group. in: path @@ -41605,7 +43332,7 @@ paths: description: Response content: application/json: - schema: &425 + schema: &442 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -41695,7 +43422,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &426 + default: &443 value: group_id: '123' group_name: Octocat admins @@ -41733,7 +43460,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: - - *76 + - *81 - *17 - name: page description: Page token @@ -41750,7 +43477,7 @@ paths: description: Response content: application/json: - schema: &423 + schema: &440 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -41790,7 +43517,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &424 + default: &441 value: groups: - group_id: '123' @@ -41824,7 +43551,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *76 + - *81 - *17 - *19 responses: @@ -41834,7 +43561,7 @@ paths: application/json: schema: type: array - items: &328 + items: &346 title: Organization Invitation description: Organization Invitation type: object @@ -41888,7 +43615,7 @@ paths: - invitation_teams_url - node_id examples: - default: &329 + default: &347 value: - id: 1 login: monalisa @@ -41947,7 +43674,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: - - *76 + - *81 responses: '200': description: Response @@ -41955,7 +43682,7 @@ paths: application/json: schema: type: array - items: &378 + items: &395 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -41969,7 +43696,7 @@ paths: - name - description examples: - default: &379 + default: &396 value: - name: add_assignee description: Assign or remove a user @@ -42000,7 +43727,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *76 + - *81 - *17 - *19 responses: @@ -42010,7 +43737,7 @@ paths: application/json: schema: type: array - items: &306 + items: &324 title: Org Hook description: Org Hook type: object @@ -42131,7 +43858,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *76 + - *81 requestBody: required: true content: @@ -42193,9 +43920,9 @@ paths: description: Response content: application/json: - schema: *306 + schema: *324 examples: - default: &307 + default: &325 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -42239,8 +43966,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *76 - - &308 + - *81 + - &326 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. @@ -42253,9 +43980,9 @@ paths: description: Response content: application/json: - schema: *306 + schema: *324 examples: - default: *307 + default: *325 '404': *6 x-github: githubCloudOnly: false @@ -42276,8 +44003,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *76 - - *308 + - *81 + - *326 requestBody: required: false content: @@ -42323,7 +44050,7 @@ paths: description: Response content: application/json: - schema: *306 + schema: *324 examples: default: value: @@ -42362,8 +44089,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *76 - - *308 + - *81 + - *326 responses: '204': description: Response @@ -42388,8 +44115,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: - - *76 - - *308 + - *81 + - *326 responses: '200': description: Response @@ -42417,8 +44144,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: - - *76 - - *308 + - *81 + - *326 requestBody: required: false content: @@ -42466,10 +44193,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *76 - - *308 + - *81 + - *326 - *17 - - *309 + - *327 responses: '200': description: Response @@ -42477,9 +44204,9 @@ paths: application/json: schema: type: array - items: *310 + items: *328 examples: - default: *311 + default: *329 '400': *14 '422': *15 x-github: @@ -42502,17 +44229,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: - - *76 - - *308 + - *81 + - *326 - *16 responses: '200': description: Response content: application/json: - schema: *312 + schema: *330 examples: - default: *313 + default: *331 '400': *14 '422': *15 x-github: @@ -42535,8 +44262,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: - - *76 - - *308 + - *81 + - *326 - *16 responses: '202': *37 @@ -42562,8 +44289,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *76 - - *308 + - *81 + - *326 responses: '204': description: Response @@ -42585,8 +44312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *76 - - &318 + - *81 + - &336 name: actor_type in: path description: The type of the actor @@ -42599,14 +44326,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &319 + - &337 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &314 + - &332 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`.' @@ -42614,7 +44341,7 @@ paths: required: true schema: type: string - - &315 + - &333 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) @@ -42625,7 +44352,7 @@ paths: type: string - *19 - *17 - - *99 + - *104 - name: sort description: The property to sort the results by. in: query @@ -42708,13 +44435,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *76 - - *314 - - *315 + - *81 + - *332 + - *333 - *19 - *17 - - *99 - - &324 + - *104 + - &342 name: sort description: The property to sort the results by. in: query @@ -42793,15 +44520,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *76 - - *314 - - *315 + - *81 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &316 + schema: &334 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -42817,7 +44544,7 @@ paths: type: integer format: int64 examples: - default: &317 + default: &335 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -42837,24 +44564,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *76 - - &320 + - *81 + - &338 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *314 - - *315 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *316 + schema: *334 examples: - default: *317 + default: *335 x-github: enabledForGitHubApps: true category: orgs @@ -42872,19 +44599,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *76 - - *314 - - *315 - - *318 - - *319 + - *81 + - *332 + - *333 + - *336 + - *337 responses: '200': description: Response content: application/json: - schema: *316 + schema: *334 examples: - default: *317 + default: *335 x-github: enabledForGitHubApps: true category: orgs @@ -42901,10 +44628,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *76 - - *314 - - *315 - - &321 + - *81 + - *332 + - *333 + - &339 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -42917,7 +44644,7 @@ paths: description: Response content: application/json: - schema: &322 + schema: &340 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -42933,7 +44660,7 @@ paths: type: integer format: int64 examples: - default: &323 + default: &341 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -42969,19 +44696,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *76 - - *320 - - *314 - - *315 - - *321 + - *81 + - *338 + - *332 + - *333 + - *339 responses: '200': description: Response content: application/json: - schema: *322 + schema: *340 examples: - default: *323 + default: *341 x-github: enabledForGitHubApps: true category: orgs @@ -42998,20 +44725,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *76 - - *318 - - *319 - - *314 - - *315 - - *321 + - *81 + - *336 + - *337 + - *332 + - *333 + - *339 responses: '200': description: Response content: application/json: - schema: *322 + schema: *340 examples: - default: *323 + default: *341 x-github: enabledForGitHubApps: true category: orgs @@ -43028,14 +44755,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *76 - - *320 - - *314 - - *315 + - *81 + - *338 + - *332 + - *333 - *19 - *17 - - *99 - - *324 + - *104 + - *342 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -43111,7 +44838,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: - - *76 + - *81 responses: '200': description: Response @@ -43119,7 +44846,7 @@ paths: application/json: schema: *20 examples: - default: &613 + default: &630 value: id: 1 account: @@ -43188,7 +44915,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *76 + - *81 - *17 - *19 responses: @@ -43277,7 +45004,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *76 + - *81 responses: '200': description: Response @@ -43285,12 +45012,12 @@ paths: application/json: schema: anyOf: - - &326 + - &344 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &325 + limit: &343 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -43318,7 +45045,7 @@ paths: properties: {} additionalProperties: false examples: - default: &327 + default: &345 value: limit: collaborators_only origin: organization @@ -43342,18 +45069,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *76 + - *81 requestBody: required: true content: application/json: - schema: &614 + schema: &631 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *325 + limit: *343 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -43378,9 +45105,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *344 examples: - default: *327 + default: *345 '422': *15 x-github: githubCloudOnly: false @@ -43398,7 +45125,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *76 + - *81 responses: '204': description: Response @@ -43424,7 +45151,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *76 + - *81 - *17 - *19 - name: role @@ -43458,9 +45185,9 @@ paths: application/json: schema: type: array - items: *328 + items: *346 examples: - default: *329 + default: *347 headers: Link: *41 '404': *6 @@ -43484,7 +45211,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *76 + - *81 requestBody: required: false content: @@ -43538,7 +45265,7 @@ paths: description: Response content: application/json: - schema: *328 + schema: *346 examples: default: value: @@ -43594,8 +45321,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *76 - - &330 + - *81 + - &348 name: invitation_id description: The unique identifier of the invitation. in: path @@ -43628,8 +45355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *76 - - *330 + - *81 + - *348 - *17 - *19 responses: @@ -43639,9 +45366,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: &345 + default: &363 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -43676,7 +45403,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: - - *76 + - *81 responses: '200': description: Response @@ -43684,7 +45411,7 @@ paths: application/json: schema: type: array - items: *331 + items: *349 examples: default: value: @@ -43722,7 +45449,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: - - *76 + - *81 requestBody: required: true content: @@ -43772,9 +45499,9 @@ paths: description: Response content: application/json: - schema: *331 + schema: *349 examples: - default: &332 + default: &350 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -43806,8 +45533,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: - - *76 - - &333 + - *81 + - &351 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -43863,9 +45590,9 @@ paths: description: Response content: application/json: - schema: *331 + schema: *349 examples: - default: *332 + default: *350 '404': *6 '422': *7 x-github: @@ -43889,8 +45616,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: - - *76 - - *333 + - *81 + - *351 responses: '204': description: Response @@ -43923,7 +45650,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: - - *76 + - *81 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -43953,7 +45680,7 @@ paths: - closed - all default: open - - *334 + - *352 - name: type description: Can be the name of an issue type. in: query @@ -43971,8 +45698,8 @@ paths: - updated - comments default: created - - *99 - - *189 + - *104 + - *206 - *17 - *19 responses: @@ -43982,9 +45709,9 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: *335 + default: *353 headers: Link: *41 '404': *6 @@ -44006,7 +45733,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *76 + - *81 - 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) @@ -44044,7 +45771,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '422': *15 @@ -44064,8 +45791,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response if requester is an organization member and user is @@ -44099,8 +45826,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -44126,8 +45853,8 @@ paths: parameters: - *17 - *19 - - *76 - - *178 + - *81 + - *194 responses: '200': description: Response @@ -44143,9 +45870,9 @@ paths: type: integer codespaces: type: array - items: *336 + items: *354 examples: - default: *337 + default: *355 '304': *35 '500': *38 '401': *23 @@ -44170,9 +45897,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *76 - - *178 - - &338 + - *81 + - *194 + - &356 name: codespace_name in: path required: true @@ -44205,17 +45932,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: - - *76 - - *178 - - *338 + - *81 + - *194 + - *356 responses: '200': description: Response content: application/json: - schema: *336 + schema: *354 examples: - default: &536 + default: &553 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -44388,14 +46115,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: - - *76 - - *178 + - *81 + - *194 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *120 + schema: *130 examples: default: value: @@ -44464,14 +46191,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *76 - - *178 + - *81 + - *194 responses: '200': description: Response content: application/json: - schema: &339 + schema: &357 title: Org Membership description: Org Membership type: object @@ -44520,7 +46247,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *62 + organization: *67 user: anyOf: - type: 'null' @@ -44540,7 +46267,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &340 + response-if-user-has-an-active-admin-membership-with-organization: &358 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -44608,8 +46335,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *76 - - *178 + - *81 + - *194 requestBody: required: false content: @@ -44637,9 +46364,9 @@ paths: description: Response content: application/json: - schema: *339 + schema: *357 examples: - response-if-user-already-had-membership-with-organization: *340 + response-if-user-already-had-membership-with-organization: *358 '422': *15 '403': *27 x-github: @@ -44663,8 +46390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -44689,7 +46416,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *76 + - *81 - *17 - *19 - name: exclude @@ -44711,7 +46438,7 @@ paths: application/json: schema: type: array - items: &341 + items: &359 title: Migration description: A migration. type: object @@ -44753,7 +46480,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *67 + items: *72 url: type: string format: uri @@ -44968,7 +46695,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *76 + - *81 requestBody: required: true content: @@ -45049,7 +46776,7 @@ paths: description: Response content: application/json: - schema: *341 + schema: *359 examples: default: value: @@ -45227,8 +46954,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *76 - - &342 + - *81 + - &360 name: migration_id description: The unique identifier of the migration. in: path @@ -45256,7 +46983,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *341 + schema: *359 examples: default: value: @@ -45425,8 +47152,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *76 - - *342 + - *81 + - *360 responses: '302': description: Response @@ -45447,8 +47174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *76 - - *342 + - *81 + - *360 responses: '204': description: Response @@ -45471,9 +47198,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *76 - - *342 - - &780 + - *81 + - *360 + - &799 name: repo_name description: repo_name parameter in: path @@ -45500,8 +47227,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *76 - - *342 + - *81 + - *360 - *17 - *19 responses: @@ -45511,9 +47238,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: &352 + default: &370 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -45652,7 +47379,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: - - *76 + - *81 responses: '200': description: Response @@ -45706,7 +47433,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: - - *76 + - *81 responses: '200': description: Response - list of organization roles @@ -45722,7 +47449,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &343 + items: &361 title: Organization Role description: Organization roles type: object @@ -45884,7 +47611,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *76 + - *81 requestBody: required: true content: @@ -45931,7 +47658,7 @@ paths: description: Response content: application/json: - schema: *343 + schema: *361 examples: default: value: @@ -45960,7 +47687,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -45982,8 +47709,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: - - *76 - - *180 + - *81 + - *197 responses: '204': description: Response @@ -46008,9 +47735,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: - - *76 - - *180 - - *291 + - *81 + - *197 + - *311 responses: '204': description: Response @@ -46039,9 +47766,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: - - *76 - - *180 - - *291 + - *81 + - *197 + - *311 responses: '204': description: Response @@ -46066,8 +47793,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -46092,9 +47819,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: - - *76 - - *178 - - *291 + - *81 + - *194 + - *311 responses: '204': description: Response @@ -46124,9 +47851,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: - - *76 - - *178 - - *291 + - *81 + - *194 + - *311 responses: '204': description: Response @@ -46154,14 +47881,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *76 - - *291 + - *81 + - *311 responses: '200': description: Response content: application/json: - schema: *343 + schema: *361 examples: default: value: @@ -46218,8 +47945,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *76 - - *291 + - *81 + - *311 requestBody: required: true content: @@ -46258,7 +47985,7 @@ paths: description: Response content: application/json: - schema: *343 + schema: *361 examples: default: value: @@ -46286,7 +48013,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *107 + '409': *112 '404': *6 x-github: githubCloudOnly: true @@ -46311,8 +48038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *76 - - *291 + - *81 + - *311 responses: '204': description: Response @@ -46337,8 +48064,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: - - *76 - - *291 + - *81 + - *311 - *17 - *19 responses: @@ -46417,7 +48144,7 @@ paths: parent: anyOf: - type: 'null' - - *344 + - *362 type: description: The ownership type of the team type: string @@ -46450,7 +48177,7 @@ paths: - type - parent examples: - default: *345 + default: *363 headers: Link: *41 '404': @@ -46479,8 +48206,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: - - *76 - - *291 + - *81 + - *311 - *17 - *19 responses: @@ -46509,7 +48236,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *344 + items: *362 name: type: - string @@ -46626,7 +48353,7 @@ paths: - type - url examples: - default: *177 + default: *193 headers: Link: *41 '404': @@ -46650,7 +48377,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: - - *76 + - *81 - 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) @@ -46677,7 +48404,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -46702,8 +48429,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: - - *76 - - *178 + - *81 + - *194 requestBody: required: false content: @@ -46760,8 +48487,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -46818,8 +48545,8 @@ paths: - docker - nuget - container - - *76 - - &782 + - *81 + - &800 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -46855,12 +48582,12 @@ paths: application/json: schema: type: array - items: *346 + items: *364 examples: - default: *347 + default: *365 '403': *27 '401': *23 - '400': &784 + '400': &802 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -46882,7 +48609,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &348 + - &366 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 @@ -46900,20 +48627,20 @@ paths: - docker - nuget - container - - &349 + - &367 name: package_name description: The name of the package. in: path required: true schema: type: string - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *346 + schema: *364 examples: default: value: @@ -46965,9 +48692,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *348 - - *349 - - *76 + - *366 + - *367 + - *81 responses: '204': description: Response @@ -46999,9 +48726,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *348 - - *349 - - *76 + - *366 + - *367 + - *81 - name: token description: package token schema: @@ -47033,9 +48760,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: - - *348 - - *349 - - *76 + - *366 + - *367 + - *81 - *19 - *17 - name: state @@ -47055,7 +48782,7 @@ paths: application/json: schema: type: array - items: &350 + items: &368 title: Package Version description: A version of a software package type: object @@ -47190,10 +48917,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: - - *348 - - *349 - - *76 - - &351 + - *366 + - *367 + - *81 + - &369 name: package_version_id description: Unique identifier of the package version. in: path @@ -47205,7 +48932,7 @@ paths: description: Response content: application/json: - schema: *350 + schema: *368 examples: default: value: @@ -47241,10 +48968,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *348 - - *349 - - *76 - - *351 + - *366 + - *367 + - *81 + - *369 responses: '204': description: Response @@ -47276,10 +49003,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *348 - - *349 - - *76 - - *351 + - *366 + - *367 + - *81 + - *369 responses: '204': description: Response @@ -47306,10 +49033,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: - - *76 + - *81 - *17 - *19 - - &353 + - &371 name: sort description: The property by which to sort the results. in: query @@ -47319,8 +49046,8 @@ paths: enum: - created_at default: created_at - - *99 - - &354 + - *104 + - &372 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -47332,7 +49059,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &355 + - &373 name: repository description: The name of the repository to use to filter the results. in: query @@ -47341,7 +49068,7 @@ paths: type: string examples: - Hello-World - - &356 + - &374 name: permission description: The permission to use to filter the results. in: query @@ -47350,7 +49077,7 @@ paths: type: string examples: - issues_read - - &357 + - &375 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) @@ -47360,7 +49087,7 @@ paths: schema: type: string format: date-time - - &358 + - &376 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) @@ -47370,7 +49097,7 @@ paths: schema: type: string format: date-time - - &359 + - &377 name: token_id description: The ID of the token in: query @@ -47538,7 +49265,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: - - *76 + - *81 requestBody: required: true content: @@ -47605,7 +49332,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: - - *76 + - *81 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -47646,7 +49373,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *129 + '204': *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47667,7 +49394,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: - - *76 + - *81 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -47687,9 +49414,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -47712,17 +49439,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: - - *76 + - *81 - *17 - *19 - - *353 - - *99 - - *354 - - *355 - - *356 - - *357 - - *358 - - *359 + - *371 + - *104 + - *372 + - *373 + - *374 + - *375 + - *376 + - *377 responses: '500': *38 '422': *15 @@ -47873,7 +49600,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: - - *76 + - *81 requestBody: required: true content: @@ -47933,7 +49660,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: - - *76 + - *81 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -47963,7 +49690,7 @@ paths: responses: '500': *38 '404': *6 - '204': *129 + '204': *139 '403': *27 '422': *15 x-github: @@ -47985,7 +49712,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: - - *76 + - *81 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -48004,9 +49731,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -48030,7 +49757,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: - - *76 + - *81 - *17 - *19 responses: @@ -48048,7 +49775,7 @@ paths: type: integer configurations: type: array - items: &360 + items: &378 title: Organization private registry description: Private registry configuration for an organization type: object @@ -48139,7 +49866,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: - - *76 + - *81 requestBody: required: true content: @@ -48307,7 +50034,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &361 + org-private-registry-with-selected-visibility: &379 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -48348,7 +50075,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: - - *76 + - *81 responses: '200': description: Response @@ -48398,16 +50125,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: - - *76 - - *256 + - *81 + - *276 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *360 + schema: *378 examples: - default: *361 + default: *379 '404': *6 x-github: githubCloudOnly: false @@ -48428,8 +50155,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: - - *76 - - *256 + - *81 + - *276 requestBody: required: true content: @@ -48525,8 +50252,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: - - *76 - - *256 + - *81 + - *276 responses: '204': description: Response @@ -48551,7 +50278,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects parameters: - - *76 + - *81 - name: state description: Indicates the state of the projects to return. in: query @@ -48572,7 +50299,7 @@ paths: application/json: schema: type: array - items: &362 + items: &380 title: Project description: Projects are a way to organize columns and cards of work. @@ -48728,7 +50455,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project parameters: - - *76 + - *81 requestBody: required: true content: @@ -48754,7 +50481,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *380 examples: default: value: @@ -48792,7 +50519,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &441 + '410': &458 description: Gone content: application/json: @@ -48818,15 +50545,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization parameters: - - *76 + - *81 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *97 - - *98 + - *102 + - *103 - *17 responses: '200': @@ -48835,7 +50562,7 @@ paths: application/json: schema: type: array - items: &363 + items: &381 title: Projects v2 Project description: A projects v2 project type: object @@ -48909,7 +50636,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &857 + - &875 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -48994,7 +50721,7 @@ paths: - deleted_at - deleted_by examples: - default: &364 + default: &382 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -49097,22 +50824,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &365 + - &383 name: project_number description: The project's number. in: path required: true schema: type: integer - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *363 + schema: *381 examples: - default: *364 + default: *382 headers: Link: *41 '304': *35 @@ -49134,11 +50861,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *365 - - *76 + - *383 + - *81 - *17 - - *97 - - *98 + - *102 + - *103 responses: '200': description: Response @@ -49146,7 +50873,7 @@ paths: application/json: schema: type: array - items: &366 + items: &384 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -49296,7 +51023,7 @@ paths: - updated_at - project_url examples: - default: &367 + default: &385 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -49339,23 +51066,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *365 - - &801 + - *383 + - &819 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *366 + schema: *384 examples: - default: *367 + default: *385 headers: Link: *41 '304': *35 @@ -49378,8 +51105,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: - - *365 - - *76 + - *383 + - *81 - 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. @@ -49388,19 +51115,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 - - *97 - - *98 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - *102 + - *103 - *17 responses: '200': @@ -49409,7 +51138,7 @@ paths: application/json: schema: type: array - items: &372 + items: &390 title: Projects v2 Item description: An item belonging to a project type: object @@ -49426,7 +51155,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: &370 + content_type: &388 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -49483,7 +51212,7 @@ paths: - updated_at - archived_at examples: - default: &373 + default: &391 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -50177,8 +51906,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - - *76 - - *365 + - *81 + - *383 requestBody: required: true description: Details of the item to add to the project. @@ -50215,7 +51944,7 @@ paths: description: Response content: application/json: - schema: &802 + schema: &820 title: Projects v2 Item description: An item belonging to a project type: object @@ -50228,8 +51957,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *183 - - &549 + - *200 + - &566 title: Pull Request Simple description: Pull Request Simple type: object @@ -50349,7 +52078,7 @@ paths: milestone: anyOf: - type: 'null' - - *368 + - *386 active_lock_reason: type: - string @@ -50404,7 +52133,7 @@ paths: type: - array - 'null' - items: *273 + items: *293 head: type: object properties: @@ -50412,7 +52141,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *72 sha: type: string user: @@ -50432,7 +52161,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *72 sha: type: string user: @@ -50448,7 +52177,7 @@ paths: _links: type: object properties: - comments: &369 + comments: &387 title: Link description: Hypermedia Link type: object @@ -50457,13 +52186,13 @@ paths: type: string required: - href - commits: *369 - statuses: *369 - html: *369 - issue: *369 - review_comments: *369 - review_comment: *369 - self: *369 + commits: *387 + statuses: *387 + html: *387 + issue: *387 + review_comments: *387 + review_comment: *387 + self: *387 required: - comments - commits @@ -50473,8 +52202,8 @@ paths: - review_comments - review_comment - self - author_association: *184 - auto_merge: &655 + author_association: *201 + auto_merge: &674 title: Auto merge description: The status of auto merging a pull request. type: @@ -50576,7 +52305,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *370 + content_type: *388 creator: *4 created_at: type: string @@ -50613,7 +52342,7 @@ paths: - updated_at - archived_at examples: - issue: &371 + issue: &389 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -50668,7 +52397,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: *371 + pull_request: *389 '304': *35 '403': *27 '401': *23 @@ -50688,9 +52417,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: - - *365 - - *76 - - &374 + - *383 + - *81 + - &392 name: item_id description: The unique identifier of the project item. in: path @@ -50698,25 +52427,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *372 + schema: *390 examples: - default: *373 + default: *391 headers: Link: *41 '304': *35 @@ -50737,9 +52468,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *365 - - *76 - - *374 + - *383 + - *81 + - *392 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -50812,13 +52543,13 @@ paths: description: Response content: application/json: - schema: *372 + schema: *390 examples: - text_field: *373 - number_field: *373 - date_field: *373 - single_select_field: *373 - iteration_field: *373 + text_field: *391 + number_field: *391 + date_field: *391 + single_select_field: *391 + iteration_field: *391 '401': *23 '403': *27 '404': *6 @@ -50838,9 +52569,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *365 - - *76 - - *374 + - *383 + - *81 + - *392 responses: '204': description: Response @@ -50864,7 +52595,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: - - *76 + - *81 responses: '200': description: Response @@ -50872,9 +52603,9 @@ paths: application/json: schema: type: array - items: *125 + items: *141 examples: - default: *126 + default: *142 '403': *27 '404': *6 x-github: @@ -50901,7 +52632,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: - - *76 + - *81 requestBody: required: true content: @@ -50912,7 +52643,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *125 + items: *141 minItems: 1 maxItems: 100 required: @@ -50942,9 +52673,9 @@ paths: application/json: schema: type: array - items: *125 + items: *141 examples: - default: *126 + default: *142 '403': *27 '404': *6 x-github: @@ -50965,16 +52696,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: - - *76 - - *127 + - *81 + - *137 responses: '200': description: Response content: application/json: - schema: *125 + schema: *141 examples: - default: *128 + default: *143 '403': *27 '404': *6 x-github: @@ -50997,13 +52728,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: - - *76 - - *127 + - *81 + - *137 requestBody: required: true content: application/json: - schema: *375 + schema: *393 examples: default: value: @@ -51019,9 +52750,9 @@ paths: description: Response content: application/json: - schema: *125 + schema: *141 examples: - default: *128 + default: *143 '403': *27 '404': *6 x-github: @@ -51044,10 +52775,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: - - *76 - - *127 + - *81 + - *137 responses: - '204': *129 + '204': *139 '403': *27 '404': *6 x-github: @@ -51068,7 +52799,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: - - *76 + - *81 - *17 - *19 - name: repository_query @@ -51109,28 +52840,7 @@ paths: - octocat/Hello-World properties: type: array - items: &376 - 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 - type: - - 'null' - - string - - array - required: - - property_name - - value + items: *140 description: List of custom property names and associated values required: - repository_id @@ -51179,7 +52889,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: - - *76 + - *81 requestBody: required: true content: @@ -51199,7 +52909,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *376 + items: *140 required: - repository_names - properties @@ -51240,7 +52950,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *76 + - *81 - *17 - *19 responses: @@ -51252,7 +52962,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -51271,8 +52981,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response if user is a public member @@ -51296,8 +53006,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -51318,8 +53028,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: - - *76 - - *178 + - *81 + - *194 responses: '204': description: Response @@ -51343,7 +53053,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *76 + - *81 - 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 @@ -51390,9 +53100,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -51413,7 +53123,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *76 + - *81 requestBody: required: true content: @@ -51596,7 +53306,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &460 title: Full Repository description: Full Repository type: object @@ -51942,7 +53652,7 @@ paths: template_repository: anyOf: - type: 'null' - - *67 + - *72 temp_clone_token: type: - string @@ -52042,13 +53752,13 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 organization: anyOf: - type: 'null' - *4 - parent: *67 - source: *67 + parent: *72 + source: *72 forks: type: integer master_branch: @@ -52061,7 +53771,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &554 + code_of_conduct: &571 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -52091,7 +53801,7 @@ paths: - key - name - html_url - security_and_analysis: *377 + security_and_analysis: *394 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -52175,7 +53885,7 @@ paths: - network_count - subscribers_count examples: - default: &445 + default: &462 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -52693,7 +54403,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: - - *76 + - *81 responses: '200': description: Response @@ -52701,9 +54411,9 @@ paths: application/json: schema: type: array - items: *378 + items: *395 examples: - default: *379 + default: *396 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -52725,10 +54435,10 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *81 - *17 - *19 - - &678 + - &697 name: targets description: | A comma-separated list of rule targets to filter by. @@ -52747,7 +54457,7 @@ paths: application/json: schema: type: array - items: *158 + items: *174 examples: default: value: @@ -52794,7 +54504,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *81 requestBody: description: Request body required: true @@ -52815,40 +54525,40 @@ paths: - push - repository default: branch - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 - conditions: *380 + items: *153 + conditions: *397 rules: type: array description: An array of rules within the ruleset. - items: &382 + items: &399 title: Repository Rule type: object description: A repository rule. oneOf: - - *138 - - *139 - - *140 - - *141 - - *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 required: - name - enforcement @@ -52886,9 +54596,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: &381 + default: &398 value: id: 21 name: super cool ruleset @@ -52942,8 +54652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *76 - - &680 + - *81 + - &699 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 @@ -52953,16 +54663,16 @@ paths: schema: type: string x-multi-segment: true - - *270 - - *94 - - &681 + - *290 + - *99 + - &700 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 - - &682 + - &701 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -52982,7 +54692,7 @@ paths: description: Response content: application/json: - schema: &683 + schema: &702 title: Rule Suites description: Response type: array @@ -53038,7 +54748,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &684 + default: &703 value: - id: 21 actor_id: 12 @@ -53081,8 +54791,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *76 - - &685 + - *81 + - &704 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -53098,7 +54808,7 @@ paths: description: Response content: application/json: - schema: &686 + schema: &705 title: Rule Suite description: Response type: object @@ -53205,7 +54915,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &687 + default: &706 value: id: 21 actor_id: 12 @@ -53266,7 +54976,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *81 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53278,9 +54988,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *381 + default: *398 '404': *6 '500': *38 put: @@ -53298,7 +55008,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *81 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53324,16 +55034,16 @@ paths: - tag - push - repository - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 - conditions: *380 + items: *153 + conditions: *397 rules: description: An array of rules within the ruleset. type: array - items: *382 + items: *399 examples: default: value: @@ -53368,9 +55078,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *381 + default: *398 '404': *6 '500': *38 delete: @@ -53388,7 +55098,7 @@ paths: category: orgs subcategory: rules parameters: - - *76 + - *81 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53411,7 +55121,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history parameters: - - *76 + - *81 - *17 - *19 - name: ruleset_id @@ -53427,9 +55137,9 @@ paths: application/json: schema: type: array - items: *162 + items: *178 examples: - default: *383 + default: *400 '404': *6 '500': *38 x-github: @@ -53448,7 +55158,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version parameters: - - *76 + - *81 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53466,7 +55176,7 @@ paths: description: Response content: application/json: - schema: *384 + schema: *401 examples: default: value: @@ -53528,15 +55238,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: - - *76 - - *385 - - *386 - - *387 - - *388 - - *99 + - *81 + - *402 + - *403 + - *404 + - *405 + - *104 - *19 - *17 - - &689 + - &708 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 @@ -53546,7 +55256,7 @@ paths: required: false schema: type: string - - &690 + - &709 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 @@ -53556,10 +55266,10 @@ paths: required: false schema: type: string - - *389 - - *390 - - *391 - - *392 + - *406 + - *407 + - *408 + - *409 responses: '200': description: Response @@ -53567,13 +55277,13 @@ paths: application/json: schema: type: array - items: *393 + items: *410 examples: - default: *394 + default: *411 headers: Link: *41 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53598,15 +55308,15 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *395 + schema: *412 examples: - default: *396 + default: *413 '403': *27 '404': *6 patch: @@ -53627,7 +55337,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *76 + - *81 requestBody: required: true content: @@ -53635,7 +55345,7 @@ paths: schema: type: object properties: - pattern_config_version: *165 + pattern_config_version: *181 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -53661,7 +55371,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *165 + custom_pattern_version: *181 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -53697,7 +55407,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *15 "/orgs/{org}/security-advisories": get: @@ -53715,8 +55425,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: - - *76 - - *99 + - *81 + - *104 - name: sort description: The property to sort the results by. in: query @@ -53728,8 +55438,8 @@ paths: - updated - published default: created - - *97 - - *98 + - *102 + - *103 - 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)." @@ -53759,7 +55469,7 @@ paths: application/json: schema: type: array - items: &711 + items: &730 description: A repository security advisory. type: object properties: @@ -53967,7 +55677,7 @@ paths: required: - vector_string - score - cvss_severities: *111 + cvss_severities: *121 cwes: type: - array @@ -54003,7 +55713,7 @@ paths: login: type: string description: The username of the user credited. - type: *397 + type: *414 credits_detailed: type: - array @@ -54014,7 +55724,7 @@ paths: type: object properties: user: *4 - type: *397 + type: *414 state: type: string description: The state of the user's acceptance of the @@ -54040,13 +55750,13 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *273 + items: *293 private_fork: readOnly: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *108 + - *113 type: - 'null' required: @@ -54078,7 +55788,7 @@ paths: - private_fork additionalProperties: false examples: - default: &712 + default: &731 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -54457,7 +56167,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *76 + - *81 responses: '200': description: Response @@ -54465,9 +56175,9 @@ paths: application/json: schema: type: array - items: *344 + items: *362 examples: - default: *345 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54490,8 +56200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *76 - - *180 + - *81 + - *197 responses: '204': description: Response @@ -54516,8 +56226,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *76 - - *180 + - *81 + - *197 responses: '204': description: Response @@ -54546,15 +56256,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *398 + schema: *415 examples: - default: *399 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54578,8 +56288,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: - - *76 - - *400 + - *81 + - *417 - *17 - *19 responses: @@ -54587,9 +56297,9 @@ paths: description: Success content: application/json: - schema: *401 + schema: *418 examples: - default: *402 + default: *419 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -54611,15 +56321,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *403 + schema: *420 examples: - default: *404 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54641,15 +56351,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *405 + schema: *422 examples: - default: *406 + default: *423 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54669,7 +56379,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: - - *76 + - *81 responses: '200': description: Immutable releases settings response @@ -54719,7 +56429,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: - - *76 + - *81 responses: '204': description: Response @@ -54777,7 +56487,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: - - *76 + - *81 - *19 - *17 responses: @@ -54795,9 +56505,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: *260 + default: *280 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54816,7 +56526,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: - - *76 + - *81 requestBody: required: true content: @@ -54865,8 +56575,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: - - *76 - - *240 + - *81 + - *260 responses: '204': description: Response @@ -54888,8 +56598,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: - - *76 - - *240 + - *81 + - *260 responses: '204': description: Response @@ -54912,7 +56622,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: - - *76 + - *81 - *17 - *19 responses: @@ -54930,9 +56640,9 @@ paths: type: integer network_configurations: type: array - items: *122 + items: *132 examples: - default: *407 + default: *424 headers: Link: *41 x-github: @@ -54953,7 +56663,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: - - *76 + - *81 requestBody: required: true content: @@ -54995,9 +56705,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: *123 + default: *133 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55017,16 +56727,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: - - *76 - - *124 + - *81 + - *134 responses: '200': description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: *123 + default: *133 headers: Link: *41 x-github: @@ -55047,8 +56757,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: - - *76 - - *124 + - *81 + - *134 requestBody: required: true content: @@ -55087,9 +56797,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *132 examples: - default: *123 + default: *133 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55108,8 +56818,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: - - *76 - - *124 + - *81 + - *134 responses: '204': description: Response @@ -55132,16 +56842,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: - - *76 - - *408 + - *81 + - *425 responses: '200': description: Response content: application/json: - schema: *409 + schema: *426 examples: - default: *410 + default: *427 headers: Link: *41 x-github: @@ -55160,7 +56870,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: - - *76 + - *81 - *17 - name: page description: Page token @@ -55179,7 +56889,7 @@ paths: description: Response content: application/json: - schema: &432 + schema: &449 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -55231,7 +56941,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &433 + default: &450 value: groups: - group_id: '123' @@ -55276,8 +56986,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: - - *76 - - *180 + - *81 + - *197 - 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`). @@ -55309,13 +57019,13 @@ paths: application/json: schema: type: array - items: *171 + items: *187 examples: - default: *172 + default: *188 '500': *38 '403': *27 '404': *6 - '422': *173 + '422': *189 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55333,7 +57043,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *76 + - *81 - *17 - *19 responses: @@ -55343,9 +57053,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 headers: Link: *41 '403': *27 @@ -55367,7 +57077,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *76 + - *81 requestBody: required: true content: @@ -55439,7 +57149,7 @@ paths: description: Response content: application/json: - schema: &411 + schema: &428 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -55513,7 +57223,7 @@ paths: parent: anyOf: - type: 'null' - - *344 + - *362 members_count: type: integer examples: @@ -55838,7 +57548,7 @@ paths: - repos_count - organization examples: - default: &412 + default: &429 value: id: 1 node_id: MDQ6VGVhbTE= @@ -55908,16 +57618,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *76 - - *180 + - *81 + - *197 responses: '200': description: Response content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '404': *6 x-github: githubCloudOnly: false @@ -55938,8 +57648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *76 - - *180 + - *81 + - *197 requestBody: required: false content: @@ -56002,16 +57712,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '201': description: Response content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '404': *6 '422': *15 '403': *27 @@ -56036,8 +57746,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *76 - - *180 + - *81 + - *197 responses: '204': description: Response @@ -56063,9 +57773,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *76 - - *180 - - *99 + - *81 + - *197 + - *104 - *17 - *19 - name: pinned @@ -56081,7 +57791,7 @@ paths: application/json: schema: type: array - items: &413 + items: &430 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -56172,7 +57882,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *185 + reactions: *202 required: - author - body @@ -56192,7 +57902,7 @@ paths: - updated_at - url examples: - default: &755 + default: &774 value: - author: login: octocat @@ -56266,8 +57976,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *76 - - *180 + - *81 + - *197 requestBody: required: true content: @@ -56301,9 +58011,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: &414 + default: &431 value: author: login: octocat @@ -56375,9 +58085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *76 - - *180 - - &415 + - *81 + - *197 + - &432 name: discussion_number description: The number that identifies the discussion. in: path @@ -56389,9 +58099,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: *414 + default: *431 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56413,9 +58123,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *76 - - *180 - - *415 + - *81 + - *197 + - *432 requestBody: required: false content: @@ -56438,9 +58148,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: &756 + default: &775 value: author: login: octocat @@ -56510,9 +58220,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *76 - - *180 - - *415 + - *81 + - *197 + - *432 responses: '204': description: Response @@ -56538,10 +58248,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *76 - - *180 - - *415 - - *99 + - *81 + - *197 + - *432 + - *104 - *17 - *19 responses: @@ -56551,7 +58261,7 @@ paths: application/json: schema: type: array - items: &416 + items: &433 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -56616,7 +58326,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *185 + reactions: *202 required: - author - body @@ -56631,7 +58341,7 @@ paths: - updated_at - url examples: - default: &757 + default: &776 value: - author: login: octocat @@ -56699,9 +58409,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *76 - - *180 - - *415 + - *81 + - *197 + - *432 requestBody: required: true content: @@ -56723,9 +58433,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: &417 + default: &434 value: author: login: octocat @@ -56791,10 +58501,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *76 - - *180 - - *415 - - &418 + - *81 + - *197 + - *432 + - &435 name: comment_number description: The number that identifies the comment. in: path @@ -56806,9 +58516,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: *417 + default: *434 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56830,10 +58540,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *76 - - *180 - - *415 - - *418 + - *81 + - *197 + - *432 + - *435 requestBody: required: true content: @@ -56855,9 +58565,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: &758 + default: &777 value: author: login: octocat @@ -56921,10 +58631,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *76 - - *180 - - *415 - - *418 + - *81 + - *197 + - *432 + - *435 responses: '204': description: Response @@ -56950,10 +58660,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: - - *76 - - *180 - - *415 - - *418 + - *81 + - *197 + - *432 + - *435 - 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. @@ -56979,7 +58689,7 @@ paths: application/json: schema: type: array - items: &419 + items: &436 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -57023,7 +58733,7 @@ paths: - content - created_at examples: - default: &421 + default: &438 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57073,10 +58783,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: - - *76 - - *180 - - *415 - - *418 + - *81 + - *197 + - *432 + - *435 requestBody: required: true content: @@ -57109,9 +58819,9 @@ paths: team discussion comment content: application/json: - schema: *419 + schema: *436 examples: - default: &420 + default: &437 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57140,9 +58850,9 @@ paths: description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57165,11 +58875,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *76 - - *180 - - *415 - - *418 - - &422 + - *81 + - *197 + - *432 + - *435 + - &439 name: reaction_id description: The unique identifier of the reaction. in: path @@ -57201,9 +58911,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *76 - - *180 - - *415 + - *81 + - *197 + - *432 - 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. @@ -57229,9 +58939,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 x-github: @@ -57257,9 +58967,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *76 - - *180 - - *415 + - *81 + - *197 + - *432 requestBody: required: true content: @@ -57291,16 +59001,16 @@ paths: description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57323,10 +59033,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *76 - - *180 - - *415 - - *422 + - *81 + - *197 + - *432 + - *439 responses: '204': description: Response @@ -57349,16 +59059,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: - - *76 - - *180 + - *81 + - *197 responses: '200': description: Response content: application/json: - schema: *423 + schema: *440 examples: - default: *424 + default: *441 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57377,8 +59087,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: - - *76 - - *180 + - *81 + - *197 requestBody: required: true content: @@ -57402,9 +59112,9 @@ paths: description: Response content: application/json: - schema: *425 + schema: *442 examples: - default: *426 + default: *443 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57423,8 +59133,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: - - *76 - - *180 + - *81 + - *197 responses: '204': description: Response @@ -57448,8 +59158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *76 - - *180 + - *81 + - *197 - *17 - *19 responses: @@ -57459,9 +59169,9 @@ paths: application/json: schema: type: array - items: *328 + items: *346 examples: - default: *329 + default: *347 headers: Link: *41 x-github: @@ -57483,8 +59193,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *76 - - *180 + - *81 + - *197 - name: role description: Filters members returned by their role in the team. in: query @@ -57507,7 +59217,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -57537,15 +59247,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *76 - - *180 - - *178 + - *81 + - *197 + - *194 responses: '200': description: Response content: application/json: - schema: &427 + schema: &444 title: Team Membership description: Team Membership type: object @@ -57573,7 +59283,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &759 + response-if-user-is-a-team-maintainer: &778 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57609,9 +59319,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: - - *76 - - *180 - - *178 + - *81 + - *197 + - *194 requestBody: required: false content: @@ -57636,9 +59346,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *444 examples: - response-if-users-membership-with-team-is-now-pending: &760 + response-if-users-membership-with-team-is-now-pending: &779 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -57673,9 +59383,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *76 - - *180 - - *178 + - *81 + - *197 + - *194 responses: '204': description: Response @@ -57700,8 +59410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *76 - - *180 + - *81 + - *197 - *17 - *19 responses: @@ -57711,7 +59421,7 @@ paths: application/json: schema: type: array - items: &428 + items: &445 title: Team Project description: A team's access to a project. type: object @@ -57780,7 +59490,7 @@ paths: - updated_at - permissions examples: - default: &761 + default: &780 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -57843,9 +59553,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *76 - - *180 - - &429 + - *81 + - *197 + - &446 name: project_id description: The unique identifier of the project. in: path @@ -57857,9 +59567,9 @@ paths: description: Response content: application/json: - schema: *428 + schema: *445 examples: - default: &762 + default: &781 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -57921,9 +59631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *76 - - *180 - - *429 + - *81 + - *197 + - *446 requestBody: required: false content: @@ -57990,9 +59700,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *76 - - *180 - - *429 + - *81 + - *197 + - *446 responses: '204': description: Response @@ -58019,8 +59729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *76 - - *180 + - *81 + - *197 - *17 - *19 responses: @@ -58030,9 +59740,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -58061,16 +59771,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *76 - - *180 - - *430 - - *431 + - *81 + - *197 + - *447 + - *448 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &763 + schema: &782 title: Team Repository description: A team's access to a repository. type: object @@ -58096,7 +59806,7 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 forks: type: integer permissions: @@ -58711,10 +60421,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *76 - - *180 - - *430 - - *431 + - *81 + - *197 + - *447 + - *448 requestBody: required: false content: @@ -58759,10 +60469,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *76 - - *180 - - *430 - - *431 + - *81 + - *197 + - *447 + - *448 responses: '204': description: Response @@ -58788,16 +60498,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: - - *76 - - *180 + - *81 + - *197 responses: '200': description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *433 + default: *450 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -58819,8 +60529,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: - - *76 - - *180 + - *81 + - *197 requestBody: required: true content: @@ -58863,7 +60573,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: default: value: @@ -58895,8 +60605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *76 - - *180 + - *81 + - *197 - *17 - *19 responses: @@ -58906,9 +60616,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - response-if-child-teams-exist: &764 + response-if-child-teams-exist: &783 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -58961,7 +60671,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: - - *76 + - *81 - name: security_product in: path description: The security feature to enable or disable. @@ -59035,7 +60745,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &434 + - &451 name: card_id description: The unique identifier of the card. in: path @@ -59047,7 +60757,7 @@ paths: description: Response content: application/json: - schema: &435 + schema: &452 title: Project Card description: Project cards represent a scope of work. type: object @@ -59122,7 +60832,7 @@ paths: - created_at - updated_at examples: - default: &436 + default: &453 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -59178,7 +60888,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *434 + - *451 requestBody: required: false content: @@ -59208,9 +60918,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '304': *35 '403': *27 '401': *23 @@ -59237,7 +60947,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *434 + - *451 responses: '204': description: Response @@ -59281,7 +60991,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *434 + - *451 requestBody: required: true content: @@ -59394,7 +61104,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &437 + - &454 name: column_id description: The unique identifier of the column. in: path @@ -59406,7 +61116,7 @@ paths: description: Response content: application/json: - schema: &438 + schema: &455 title: Project Column description: Project columns contain cards of work. type: object @@ -59460,7 +61170,7 @@ paths: - created_at - updated_at examples: - default: &439 + default: &456 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -59495,7 +61205,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *437 + - *454 requestBody: required: true content: @@ -59520,9 +61230,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *455 examples: - default: *439 + default: *456 '304': *35 '403': *27 '401': *23 @@ -59547,7 +61257,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *437 + - *454 responses: '204': description: Response @@ -59576,7 +61286,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *437 + - *454 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -59597,7 +61307,7 @@ paths: application/json: schema: type: array - items: *435 + items: *452 examples: default: value: @@ -59656,7 +61366,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *437 + - *454 requestBody: required: true content: @@ -59700,9 +61410,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *452 examples: - default: *436 + default: *453 '304': *35 '403': *27 '401': *23 @@ -59712,8 +61422,8 @@ paths: application/json: schema: oneOf: - - *223 - - *224 + - *241 + - *242 '503': description: Response content: @@ -59758,7 +61468,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *437 + - *454 requestBody: required: true content: @@ -59819,15 +61529,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project parameters: - - *429 + - *446 responses: '200': description: Response content: application/json: - schema: *362 + schema: *380 examples: - default: &440 + default: &457 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -59884,7 +61594,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project parameters: - - *429 + - *446 requestBody: required: false content: @@ -59933,9 +61643,9 @@ paths: description: Response content: application/json: - schema: *362 + schema: *380 examples: - default: *440 + default: *457 '404': description: Not Found if the authenticated user does not have access to the project @@ -59956,7 +61666,7 @@ paths: items: type: string '401': *23 - '410': *441 + '410': *458 '422': *7 x-github: githubCloudOnly: false @@ -59979,7 +61689,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project parameters: - - *429 + - *446 responses: '204': description: Delete Success @@ -60000,7 +61710,7 @@ paths: items: type: string '401': *23 - '410': *441 + '410': *458 '404': *6 x-github: githubCloudOnly: false @@ -60024,7 +61734,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *429 + - *446 - 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 @@ -60051,7 +61761,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '404': *6 @@ -60081,8 +61791,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *429 - - *178 + - *446 + - *194 requestBody: required: false content: @@ -60136,8 +61846,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *429 - - *178 + - *446 + - *194 responses: '204': description: Response @@ -60168,8 +61878,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: - - *429 - - *178 + - *446 + - *194 responses: '200': description: Response @@ -60239,7 +61949,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#list-project-columns parameters: - - *429 + - *446 - *17 - *19 responses: @@ -60249,7 +61959,7 @@ paths: application/json: schema: type: array - items: *438 + items: *455 examples: default: value: @@ -60287,7 +61997,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#create-a-project-column parameters: - - *429 + - *446 requestBody: required: true content: @@ -60311,7 +62021,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *455 examples: default: value: @@ -60376,7 +62086,7 @@ paths: resources: type: object properties: - core: &442 + core: &459 title: Rate Limit type: object properties: @@ -60393,21 +62103,21 @@ paths: - remaining - reset - used - graphql: *442 - search: *442 - code_search: *442 - source_import: *442 - integration_manifest: *442 - code_scanning_upload: *442 - actions_runner_registration: *442 - scim: *442 - dependency_snapshots: *442 - dependency_sbom: *442 - code_scanning_autofix: *442 + graphql: *459 + search: *459 + code_search: *459 + source_import: *459 + integration_manifest: *459 + code_scanning_upload: *459 + actions_runner_registration: *459 + scim: *459 + dependency_snapshots: *459 + dependency_sbom: *459 + code_scanning_autofix: *459 required: - core - search - rate: *442 + rate: *459 required: - rate - resources @@ -60512,14 +62222,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *443 + schema: *460 examples: default-response: summary: Default response @@ -61024,7 +62734,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *444 + '301': *461 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61042,8 +62752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -61301,10 +63011,10 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - default: *445 - '307': &446 + default: *462 + '307': &463 description: Temporary Redirect content: application/json: @@ -61333,8 +63043,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -61356,9 +63066,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': *446 + '307': *463 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61380,11 +63090,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 - - &461 + - &478 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -61407,7 +63117,7 @@ paths: type: integer artifacts: type: array - items: &447 + items: &464 title: Artifact description: An artifact type: object @@ -61502,7 +63212,7 @@ paths: - expires_at - updated_at examples: - default: &462 + default: &479 value: total_count: 2 artifacts: @@ -61563,9 +63273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *430 - - *431 - - &448 + - *447 + - *448 + - &465 name: artifact_id description: The unique identifier of the artifact. in: path @@ -61577,7 +63287,7 @@ paths: description: Response content: application/json: - schema: *447 + schema: *464 examples: default: value: @@ -61615,9 +63325,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *430 - - *431 + - *447 - *448 + - *465 responses: '204': description: Response @@ -61641,9 +63351,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *430 - - *431 + - *447 - *448 + - *465 - name: archive_format in: path required: true @@ -61657,7 +63367,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': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61680,14 +63390,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *449 + schema: *466 examples: default: value: @@ -61713,11 +63423,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: - - *430 - - *431 + - *447 + - *448 - *17 - *19 - - &450 + - &467 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 @@ -61745,13 +63455,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *99 + - *104 responses: '200': description: Response content: application/json: - schema: &451 + schema: &468 title: Repository actions caches description: Repository actions caches type: object @@ -61801,7 +63511,7 @@ paths: - total_count - actions_caches examples: - default: &452 + default: &469 value: total_count: 1 actions_caches: @@ -61833,23 +63543,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: - - *430 - - *431 + - *447 + - *448 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *450 + - *467 responses: '200': description: Response content: application/json: - schema: *451 + schema: *468 examples: - default: *452 + default: *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61869,8 +63579,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: - - *430 - - *431 + - *447 + - *448 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -61901,9 +63611,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: - - *430 - - *431 - - &453 + - *447 + - *448 + - &470 name: job_id description: The unique identifier of the job. in: path @@ -61915,7 +63625,7 @@ paths: description: Response content: application/json: - schema: &465 + schema: &482 title: Job description: Information of a job execution in a workflow run type: object @@ -62262,9 +63972,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: - - *430 - - *431 - - *453 + - *447 + - *448 + - *470 responses: '302': description: Response @@ -62292,9 +64002,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: - - *430 - - *431 - - *453 + - *447 + - *448 + - *470 requestBody: required: false content: @@ -62316,7 +64026,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -62340,8 +64050,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Status response @@ -62391,8 +64101,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -62426,7 +64136,7 @@ paths: description: Empty response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -62455,8 +64165,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -62474,7 +64184,7 @@ paths: type: integer secrets: type: array - items: &467 + items: &484 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -62495,7 +64205,7 @@ paths: - created_at - updated_at examples: - default: &468 + default: &485 value: total_count: 2 secrets: @@ -62528,9 +64238,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *430 - - *431 - - *454 + - *447 + - *448 + - *471 - *19 responses: '200': @@ -62547,7 +64257,7 @@ paths: type: integer variables: type: array - items: &471 + items: &488 title: Actions Variable type: object properties: @@ -62581,7 +64291,7 @@ paths: - created_at - updated_at examples: - default: &472 + default: &489 value: total_count: 2 variables: @@ -62614,8 +64324,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -62624,12 +64334,12 @@ paths: schema: type: object properties: - enabled: &455 + enabled: &472 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *49 - selected_actions_url: *233 - sha_pinning_required: *50 + allowed_actions: *54 + selected_actions_url: *253 + sha_pinning_required: *55 required: - enabled examples: @@ -62659,8 +64369,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -62671,9 +64381,9 @@ paths: schema: type: object properties: - enabled: *455 - allowed_actions: *49 - sha_pinning_required: *50 + enabled: *472 + allowed_actions: *54 + sha_pinning_required: *55 required: - enabled examples: @@ -62704,14 +64414,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: &456 + schema: &473 type: object properties: access_level: @@ -62729,7 +64439,7 @@ paths: required: - access_level examples: - default: &457 + default: &474 value: access_level: organization x-github: @@ -62754,15 +64464,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: application/json: - schema: *456 + schema: *473 examples: - default: *457 + default: *474 responses: '204': description: Response @@ -62786,14 +64496,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *235 + schema: *255 examples: default: value: @@ -62817,8 +64527,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Empty response for successful settings update @@ -62828,7 +64538,7 @@ paths: required: true content: application/json: - schema: *236 + schema: *256 examples: default: summary: Set retention days @@ -62852,16 +64562,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *51 + schema: *56 examples: - default: *237 + default: *257 '404': *6 x-github: enabledForGitHubApps: true @@ -62880,8 +64590,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -62891,7 +64601,7 @@ paths: required: true content: application/json: - schema: *51 + schema: *56 examples: default: summary: Set approval policy to first time contributors @@ -62915,16 +64625,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *238 + schema: *258 examples: - default: *52 + default: *57 '403': *27 '404': *6 x-github: @@ -62944,15 +64654,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: application/json: - schema: *239 + schema: *259 examples: - default: *52 + default: *57 responses: '204': description: Empty response for successful settings update @@ -62976,16 +64686,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *54 + schema: *59 examples: - default: *55 + default: *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63008,8 +64718,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -63017,9 +64727,9 @@ paths: required: false content: application/json: - schema: *54 + schema: *59 examples: - selected_actions: *55 + selected_actions: *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63041,16 +64751,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *242 + schema: *262 examples: - default: *58 + default: *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63071,8 +64781,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Success response @@ -63083,9 +64793,9 @@ paths: required: true content: application/json: - schema: *243 + schema: *263 examples: - default: *58 + default: *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63112,8 +64822,8 @@ paths: in: query schema: type: string - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -63131,9 +64841,9 @@ paths: type: integer runners: type: array - items: *65 + items: *70 examples: - default: *66 + default: *71 headers: Link: *41 x-github: @@ -63157,8 +64867,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -63166,9 +64876,9 @@ paths: application/json: schema: type: array - items: *247 + items: *267 examples: - default: *248 + default: *268 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63190,8 +64900,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -63234,10 +64944,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *249 + '201': *269 '404': *6 '422': *7 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63265,16 +64975,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: - - *430 - - *431 + - *447 + - *448 responses: '201': description: Response content: application/json: - schema: *68 + schema: *73 examples: - default: *250 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63302,16 +65012,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: - - *430 - - *431 + - *447 + - *448 responses: '201': description: Response content: application/json: - schema: *68 + schema: *73 examples: - default: *251 + default: *271 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63333,17 +65043,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 responses: '200': description: Response content: application/json: - schema: *65 + schema: *70 examples: - default: *252 + default: *272 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63364,9 +65074,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 responses: '204': description: Response @@ -63392,11 +65102,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 responses: - '200': *70 + '200': *75 '404': *6 x-github: githubCloudOnly: false @@ -63418,9 +65128,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 requestBody: required: true content: @@ -63444,7 +65154,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -63468,9 +65178,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 requestBody: required: true content: @@ -63495,7 +65205,7 @@ paths: - gpu - accelerated responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -63519,11 +65229,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: - - *430 - - *431 - - *64 + - *447 + - *448 + - *69 responses: - '200': *253 + '200': *273 '404': *6 x-github: githubCloudOnly: false @@ -63550,12 +65260,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: - - *430 - - *431 - - *64 - - *254 + - *447 + - *448 + - *69 + - *274 responses: - '200': *70 + '200': *75 '404': *6 '422': *7 x-github: @@ -63581,9 +65291,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: - - *430 - - *431 - - &475 + - *447 + - *448 + - &492 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. @@ -63591,7 +65301,7 @@ paths: required: false schema: type: string - - &476 + - &493 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -63599,7 +65309,7 @@ paths: required: false schema: type: string - - &477 + - &494 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -63608,7 +65318,7 @@ paths: required: false schema: type: string - - &478 + - &495 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 @@ -63635,7 +65345,7 @@ paths: - pending - *17 - *19 - - &479 + - &496 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)." @@ -63644,7 +65354,7 @@ paths: schema: type: string format: date-time - - &458 + - &475 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -63653,13 +65363,13 @@ paths: schema: type: boolean default: false - - &480 + - &497 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &481 + - &498 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -63682,7 +65392,7 @@ paths: type: integer workflow_runs: type: array - items: &459 + items: &476 title: Workflow Run description: An invocation of a workflow type: object @@ -63799,7 +65509,7 @@ paths: type: - array - 'null' - items: *187 + items: *204 created_at: type: string format: date-time @@ -63860,7 +65570,7 @@ paths: head_commit: anyOf: - type: 'null' - - &503 + - &520 title: Simple Commit description: A commit. type: object @@ -63934,8 +65644,8 @@ paths: - timestamp - author - committer - repository: *246 - head_repository: *246 + repository: *266 + head_repository: *266 head_repository_id: type: integer examples: @@ -63975,7 +65685,7 @@ paths: - workflow_url - pull_requests examples: - default: &482 + default: &499 value: total_count: 1 workflow_runs: @@ -64211,24 +65921,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *430 - - *431 - - &460 + - *447 + - *448 + - &477 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *458 + - *475 responses: '200': description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: &463 + default: &480 value: id: 30433642 name: Build @@ -64469,9 +66179,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '204': description: Response @@ -64494,9 +66204,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '200': description: Response @@ -64624,15 +66334,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '201': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -64659,12 +66369,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 - *17 - *19 - - *461 + - *478 responses: '200': description: Response @@ -64680,9 +66390,9 @@ paths: type: integer artifacts: type: array - items: *447 + items: *464 examples: - default: *462 + default: *479 headers: Link: *41 x-github: @@ -64706,25 +66416,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *430 - - *431 - - *460 - - &464 + - *447 + - *448 + - *477 + - &481 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *458 + - *475 responses: '200': description: Response content: application/json: - schema: *459 + schema: *476 examples: - default: *463 + default: *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64747,10 +66457,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: - - *430 - - *431 - - *460 - - *464 + - *447 + - *448 + - *477 + - *481 - *17 - *19 responses: @@ -64768,9 +66478,9 @@ paths: type: integer jobs: type: array - items: *465 + items: *482 examples: - default: &466 + default: &483 value: total_count: 1 jobs: @@ -64883,10 +66593,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *430 - - *431 - - *460 - - *464 + - *447 + - *448 + - *477 + - *481 responses: '302': description: Response @@ -64914,19 +66624,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '202': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64949,9 +66659,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 requestBody: required: true content: @@ -65018,19 +66728,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '202': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65053,9 +66763,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 - 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 @@ -65085,9 +66795,9 @@ paths: type: integer jobs: type: array - items: *465 + items: *482 examples: - default: *466 + default: *483 headers: Link: *41 x-github: @@ -65112,9 +66822,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '302': description: Response @@ -65141,9 +66851,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '204': description: Response @@ -65170,9 +66880,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '200': description: Response @@ -65241,7 +66951,7 @@ paths: items: type: object properties: - type: &583 + type: &600 type: string description: The type of reviewer. enum: @@ -65252,7 +66962,7 @@ paths: reviewer: anyOf: - *4 - - *273 + - *293 required: - environment - wait_timer @@ -65327,9 +67037,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 requestBody: required: true content: @@ -65379,7 +67089,7 @@ paths: application/json: schema: type: array - items: &569 + items: &586 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -65491,7 +67201,7 @@ paths: - created_at - updated_at examples: - default: &570 + default: &587 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -65547,9 +67257,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 requestBody: required: false content: @@ -65571,7 +67281,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -65594,9 +67304,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: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 requestBody: required: false content: @@ -65618,7 +67328,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -65651,9 +67361,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *430 - - *431 - - *460 + - *447 + - *448 + - *477 responses: '200': description: Response @@ -65790,8 +67500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -65809,9 +67519,9 @@ paths: type: integer secrets: type: array - items: *467 + items: *484 examples: - default: *468 + default: *485 headers: Link: *41 x-github: @@ -65836,16 +67546,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *469 + schema: *486 examples: - default: *470 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65867,17 +67577,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '200': description: Response content: application/json: - schema: *467 + schema: *484 examples: - default: &596 + default: &613 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -65903,9 +67613,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 requestBody: required: true content: @@ -65936,7 +67646,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -65962,9 +67672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '204': description: Response @@ -65989,9 +67699,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *430 - - *431 - - *454 + - *447 + - *448 + - *471 - *19 responses: '200': @@ -66008,9 +67718,9 @@ paths: type: integer variables: type: array - items: *471 + items: *488 examples: - default: *472 + default: *489 headers: Link: *41 x-github: @@ -66033,8 +67743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -66061,7 +67771,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -66086,17 +67796,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *430 - - *431 - - *259 + - *447 + - *448 + - *279 responses: '200': description: Response content: application/json: - schema: *471 + schema: *488 examples: - default: &597 + default: &614 value: name: USERNAME value: octocat @@ -66122,9 +67832,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *430 - - *431 - - *259 + - *447 + - *448 + - *279 requestBody: required: true content: @@ -66166,9 +67876,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *430 - - *431 - - *259 + - *447 + - *448 + - *279 responses: '204': description: Response @@ -66193,8 +67903,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -66212,7 +67922,7 @@ paths: type: integer workflows: type: array - items: &473 + items: &490 title: Workflow description: A GitHub Actions workflow type: object @@ -66330,9 +68040,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *430 - - *431 - - &474 + - *447 + - *448 + - &491 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -66347,7 +68057,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *490 examples: default: value: @@ -66380,9 +68090,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *430 - - *431 - - *474 + - *447 + - *448 + - *491 responses: '204': description: Response @@ -66407,9 +68117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *430 - - *431 - - *474 + - *447 + - *448 + - *491 responses: '204': description: Response @@ -66460,9 +68170,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *430 - - *431 - - *474 + - *447 + - *448 + - *491 responses: '204': description: Response @@ -66489,19 +68199,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: - - *430 - - *431 - - *474 - - *475 - - *476 - - *477 - - *478 + - *447 + - *448 + - *491 + - *492 + - *493 + - *494 + - *495 - *17 - *19 - - *479 - - *458 - - *480 - - *481 + - *496 + - *475 + - *497 + - *498 responses: '200': description: Response @@ -66517,9 +68227,9 @@ paths: type: integer workflow_runs: type: array - items: *459 + items: *476 examples: - default: *482 + default: *499 headers: Link: *41 x-github: @@ -66552,9 +68262,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *430 - - *431 - - *474 + - *447 + - *448 + - *491 responses: '200': description: Response @@ -66615,12 +68325,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *430 - - *431 - - *99 + - *447 + - *448 + - *104 - *17 - - *97 - - *98 + - *102 + - *103 - name: ref description: |- The Git reference for the activities you want to list. @@ -66784,8 +68494,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -66797,7 +68507,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '404': *6 @@ -66822,8 +68532,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: - - *430 - - *431 + - *447 + - *448 - name: assignee in: path required: true @@ -66859,8 +68569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -66972,11 +68682,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *430 - - *431 + - *447 + - *448 - *17 - - *97 - - *98 + - *102 + - *103 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -67029,7 +68739,7 @@ paths: initiator: type: string examples: - default: *483 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67049,8 +68759,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -67058,7 +68768,7 @@ paths: application/json: schema: type: array - items: &484 + items: &501 title: Autolink reference description: An autolink reference. type: object @@ -67117,8 +68827,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -67157,9 +68867,9 @@ paths: description: response content: application/json: - schema: *484 + schema: *501 examples: - default: &485 + default: &502 value: id: 1 key_prefix: TICKET- @@ -67190,9 +68900,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: - - *430 - - *431 - - &486 + - *447 + - *448 + - &503 name: autolink_id description: The unique identifier of the autolink. in: path @@ -67204,9 +68914,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *501 examples: - default: *485 + default: *502 '404': *6 x-github: githubCloudOnly: false @@ -67226,9 +68936,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: - - *430 - - *431 - - *486 + - *447 + - *448 + - *503 responses: '204': description: Response @@ -67252,8 +68962,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response if Dependabot is enabled @@ -67303,8 +69013,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -67325,8 +69035,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -67346,8 +69056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *430 - - *431 + - *447 + - *448 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -67385,7 +69095,7 @@ paths: - url protected: type: boolean - protection: &488 + protection: &505 title: Branch Protection description: Branch Protection type: object @@ -67428,7 +69138,7 @@ paths: required: - contexts - checks - enforce_admins: &491 + enforce_admins: &508 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -67445,7 +69155,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &493 + required_pull_request_reviews: &510 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -67467,7 +69177,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *273 + items: *293 apps: description: The list of apps with review dismissal access. @@ -67499,7 +69209,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *273 + items: *293 apps: description: The list of apps allowed to bypass pull request requirements. @@ -67529,7 +69239,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &490 + restrictions: &507 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -67592,7 +69302,7 @@ paths: type: string teams: type: array - items: *273 + items: *293 apps: type: array items: @@ -67822,9 +69532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *430 - - *431 - - &489 + - *447 + - *448 + - &506 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). @@ -67838,14 +69548,14 @@ paths: description: Response content: application/json: - schema: &499 + schema: &516 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &545 + commit: &562 title: Commit description: Commit type: object @@ -67884,7 +69594,7 @@ paths: author: anyOf: - type: 'null' - - &487 + - &504 title: Git User description: Metaproperties for Git author/committer information. @@ -67905,7 +69615,7 @@ paths: committer: anyOf: - type: 'null' - - *487 + - *504 message: type: string examples: @@ -67929,7 +69639,7 @@ paths: required: - sha - url - verification: &603 + verification: &620 title: Verification type: object properties: @@ -67965,14 +69675,14 @@ paths: author: oneOf: - *4 - - *257 + - *277 type: - 'null' - object committer: oneOf: - *4 - - *257 + - *277 type: - 'null' - object @@ -68009,7 +69719,7 @@ paths: type: integer files: type: array - items: &556 + items: &573 title: Diff Entry description: Diff Entry type: object @@ -68105,7 +69815,7 @@ paths: - self protected: type: boolean - protection: *488 + protection: *505 protection_url: type: string format: uri @@ -68214,7 +69924,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *444 + '301': *461 '404': *6 x-github: githubCloudOnly: false @@ -68236,15 +69946,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *488 + schema: *505 examples: default: value: @@ -68438,9 +70148,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -68700,7 +70410,7 @@ paths: url: type: string format: uri - required_status_checks: &496 + required_status_checks: &513 title: Status Check Policy description: Status Check Policy type: object @@ -68781,7 +70491,7 @@ paths: items: *4 teams: type: array - items: *273 + items: *293 apps: type: array items: *5 @@ -68799,7 +70509,7 @@ paths: items: *4 teams: type: array - items: *273 + items: *293 apps: type: array items: *5 @@ -68859,7 +70569,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *490 + restrictions: *507 required_conversation_resolution: type: object properties: @@ -68971,9 +70681,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -68998,17 +70708,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *491 + schema: *508 examples: - default: &492 + default: &509 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -69030,17 +70740,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *491 + schema: *508 examples: - default: *492 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69059,9 +70769,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -69086,17 +70796,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *493 + schema: *510 examples: - default: &494 + default: &511 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -69192,9 +70902,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -69292,9 +71002,9 @@ paths: description: Response content: application/json: - schema: *493 + schema: *510 examples: - default: *494 + default: *511 '422': *15 x-github: githubCloudOnly: false @@ -69315,9 +71025,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -69344,17 +71054,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *491 + schema: *508 examples: - default: &495 + default: &512 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -69377,17 +71087,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *491 + schema: *508 examples: - default: *495 + default: *512 '404': *6 x-github: githubCloudOnly: false @@ -69407,9 +71117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -69434,17 +71144,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *496 + schema: *513 examples: - default: &497 + default: &514 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -69470,9 +71180,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -69524,9 +71234,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *513 examples: - default: *497 + default: *514 '404': *6 '422': *15 x-github: @@ -69548,9 +71258,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -69574,9 +71284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response @@ -69610,9 +71320,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -69679,9 +71389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -69745,9 +71455,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: content: application/json: @@ -69813,15 +71523,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response content: application/json: - schema: *490 + schema: *507 examples: default: value: @@ -69912,9 +71622,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '204': description: Response @@ -69937,9 +71647,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: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response @@ -69949,7 +71659,7 @@ paths: type: array items: *5 examples: - default: &498 + default: &515 value: - id: 1 slug: octoapp @@ -70006,9 +71716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70042,7 +71752,7 @@ paths: type: array items: *5 examples: - default: *498 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -70063,9 +71773,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70099,7 +71809,7 @@ paths: type: array items: *5 examples: - default: *498 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -70120,9 +71830,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70156,7 +71866,7 @@ paths: type: array items: *5 examples: - default: *498 + default: *515 '422': *15 x-github: githubCloudOnly: false @@ -70178,9 +71888,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: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response @@ -70188,9 +71898,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 '404': *6 x-github: githubCloudOnly: false @@ -70210,9 +71920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -70248,9 +71958,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 '422': *15 x-github: githubCloudOnly: false @@ -70271,9 +71981,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: false content: @@ -70309,9 +72019,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 '422': *15 x-github: githubCloudOnly: false @@ -70332,9 +72042,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: content: application/json: @@ -70369,9 +72079,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 '422': *15 x-github: githubCloudOnly: false @@ -70393,9 +72103,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: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 responses: '200': description: Response @@ -70405,7 +72115,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 '404': *6 x-github: githubCloudOnly: false @@ -70429,9 +72139,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70464,7 +72174,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 '422': *15 x-github: githubCloudOnly: false @@ -70489,9 +72199,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70524,7 +72234,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 '422': *15 x-github: githubCloudOnly: false @@ -70549,9 +72259,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70584,7 +72294,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 '422': *15 x-github: githubCloudOnly: false @@ -70611,9 +72321,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 requestBody: required: true content: @@ -70635,7 +72345,7 @@ paths: description: Response content: application/json: - schema: *499 + schema: *516 examples: default: value: @@ -70749,12 +72459,12 @@ paths: category: repos subcategory: bypass-requests parameters: - - *430 - - *431 - - *92 - - *93 - - *94 - - *95 + - *447 + - *448 + - *97 + - *98 + - *99 + - *100 - *17 - *19 responses: @@ -70764,9 +72474,9 @@ paths: application/json: schema: type: array - items: *268 + items: *288 examples: - default: *269 + default: *289 '404': *6 '500': *38 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -70786,8 +72496,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: bypass_request_number in: path required: true @@ -70801,7 +72511,7 @@ paths: description: Response content: application/json: - schema: *268 + schema: *288 examples: default: value: @@ -70860,12 +72570,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *430 - - *431 - - *92 - - *93 - - *94 - - *95 + - *447 + - *448 + - *97 + - *98 + - *99 + - *100 - *17 - *19 responses: @@ -70875,9 +72585,9 @@ paths: application/json: schema: type: array - items: *271 + items: *291 examples: - default: *272 + default: *292 '404': *6 '403': *27 '500': *38 @@ -70901,8 +72611,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *430 - - *431 + - *447 + - *448 - name: bypass_request_number in: path required: true @@ -70914,7 +72624,7 @@ paths: description: A single bypass request. content: application/json: - schema: *271 + schema: *291 examples: default: value: @@ -70972,8 +72682,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *430 - - *431 + - *447 + - *448 - name: bypass_request_number in: path required: true @@ -71044,8 +72754,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *430 - - *431 + - *447 + - *448 - name: bypass_response_id in: path required: true @@ -71078,8 +72788,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -71358,7 +73068,7 @@ paths: description: Response content: application/json: - schema: &500 + schema: &517 title: CheckRun description: A check performed on the code of a given code change type: object @@ -71493,8 +73203,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *187 - deployment: &818 + items: *204 + deployment: &836 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -71781,9 +73491,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *430 - - *431 - - &501 + - *447 + - *448 + - &518 name: check_run_id description: The unique identifier of the check run. in: path @@ -71795,9 +73505,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *517 examples: - default: &502 + default: &519 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -71897,9 +73607,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *430 - - *431 - - *501 + - *447 + - *448 + - *518 requestBody: required: true content: @@ -72139,9 +73849,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *517 examples: - default: *502 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72161,9 +73871,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *430 - - *431 - - *501 + - *447 + - *448 + - *518 - *17 - *19 responses: @@ -72273,15 +73983,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *430 - - *431 - - *501 + - *447 + - *448 + - *518 responses: '201': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -72319,8 +74029,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -72342,7 +74052,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &504 + schema: &521 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -72424,12 +74134,12 @@ paths: type: - array - 'null' - items: *187 + items: *204 app: anyOf: - type: 'null' - *5 - repository: *246 + repository: *266 created_at: type: - string @@ -72440,7 +74150,7 @@ paths: - string - 'null' format: date-time - head_commit: *503 + head_commit: *520 latest_check_runs_count: type: integer check_runs_url: @@ -72468,7 +74178,7 @@ paths: - check_runs_url - pull_requests examples: - default: &505 + default: &522 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -72759,9 +74469,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *504 + schema: *521 examples: - default: *505 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72780,8 +74490,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -72842,7 +74552,7 @@ paths: required: - app_id - setting - repository: *246 + repository: *266 examples: default: value: @@ -73090,9 +74800,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *430 - - *431 - - &506 + - *447 + - *448 + - &523 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -73104,9 +74814,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *521 examples: - default: *505 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73129,17 +74839,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: - - *430 - - *431 - - *506 - - &551 + - *447 + - *448 + - *523 + - &568 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &552 + - &569 name: status description: Returns check runs with the specified `status`. in: query @@ -73178,9 +74888,9 @@ paths: type: integer check_runs: type: array - items: *500 + items: *517 examples: - default: &553 + default: &570 value: total_count: 1 check_runs: @@ -73282,15 +74992,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *430 - - *431 - - *506 + - *447 + - *448 + - *523 responses: '201': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -73317,30 +75027,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: - - *430 - - *431 - - *277 - - *278 + - *447 + - *448 + - *297 + - *298 - *19 - *17 - - &522 + - &539 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: *507 - - &523 + schema: *524 + - &540 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *99 - - *97 - - *98 + - *104 + - *102 + - *103 - name: sort description: The property by which to sort the results. in: query @@ -73356,13 +75066,13 @@ paths: be returned. in: query required: false - schema: *279 + schema: *299 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *508 + schema: *525 responses: '200': description: Response @@ -73373,24 +75083,24 @@ paths: items: type: object properties: - number: *109 - created_at: *116 - updated_at: *117 - url: *114 - html_url: *115 - instances_url: *509 - state: *102 - fixed_at: *119 + number: *119 + created_at: *126 + updated_at: *127 + url: *124 + html_url: *125 + instances_url: *526 + state: *107 + fixed_at: *129 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *118 - dismissed_reason: *510 - dismissed_comment: *511 - rule: *512 - tool: *513 - most_recent_instance: *514 + dismissed_at: *128 + dismissed_reason: *527 + dismissed_comment: *528 + rule: *529 + tool: *530 + most_recent_instance: *531 dismissal_approved_by: anyOf: - type: 'null' @@ -73513,14 +75223,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &515 + '403': &532 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73540,9 +75250,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: - - *430 - - *431 - - &516 + - *447 + - *448 + - &533 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -73550,30 +75260,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *109 + schema: *119 responses: '200': description: Response content: application/json: - schema: &517 + schema: &534 type: object properties: - number: *109 - created_at: *116 - updated_at: *117 - url: *114 - html_url: *115 - instances_url: *509 - state: *102 - fixed_at: *119 + number: *119 + created_at: *126 + updated_at: *127 + url: *124 + html_url: *125 + instances_url: *526 + state: *107 + fixed_at: *129 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *118 - dismissed_reason: *510 - dismissed_comment: *511 + dismissed_at: *128 + dismissed_reason: *527 + dismissed_comment: *528 rule: type: object properties: @@ -73635,8 +75345,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *513 - most_recent_instance: *514 + tool: *530 + most_recent_instance: *531 dismissal_approved_by: anyOf: - type: 'null' @@ -73732,9 +75442,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73752,9 +75462,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 requestBody: required: true content: @@ -73769,8 +75479,8 @@ paths: enum: - open - dismissed - dismissed_reason: *510 - dismissed_comment: *511 + dismissed_reason: *527 + dismissed_comment: *528 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -73789,7 +75499,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *534 examples: default: value: @@ -73865,14 +75575,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &521 + '403': &538 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': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -73892,15 +75602,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 responses: '200': description: Response content: application/json: - schema: &518 + schema: &535 type: object properties: status: @@ -73927,13 +75637,13 @@ paths: - description - started_at examples: - default: &519 + default: &536 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &520 + '400': &537 description: Bad Request content: application/json: @@ -73944,9 +75654,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': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73969,29 +75679,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 responses: '200': description: OK content: application/json: - schema: *518 + schema: *535 examples: - default: *519 + default: *536 '202': description: Accepted content: application/json: - schema: *518 + schema: *535 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *520 + '400': *537 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -74001,7 +75711,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74023,9 +75733,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 requestBody: required: false content: @@ -74071,12 +75781,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *520 - '403': *521 + '400': *537 + '403': *538 '404': *6 '422': description: Unprocessable Entity - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74096,13 +75806,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 - *19 - *17 - - *522 - - *523 + - *539 + - *540 responses: '200': description: Response @@ -74110,7 +75820,7 @@ paths: application/json: schema: type: array - items: *514 + items: *531 examples: default: value: @@ -74149,9 +75859,9 @@ paths: end_column: 50 classifications: - source - '403': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74183,30 +75893,30 @@ 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: - - *430 - - *431 - - *277 - - *278 + - *447 + - *448 + - *297 + - *298 - *19 - *17 - - *523 + - *540 - 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: *507 + schema: *524 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &526 + schema: &543 type: string description: An identifier for the upload. examples: - 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *99 + - *104 - name: sort description: The property by which to sort the results. in: query @@ -74223,23 +75933,23 @@ paths: application/json: schema: type: array - items: &527 + items: &544 type: object properties: - ref: *507 - commit_sha: &535 + ref: *524 + commit_sha: &552 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: *524 + analysis_key: *541 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *525 + category: *542 error: type: string examples: @@ -74264,8 +75974,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *526 - tool: *513 + sarif_id: *543 + tool: *530 deletable: type: boolean warning: @@ -74327,9 +76037,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74363,8 +76073,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: - - *430 - - *431 + - *447 + - *448 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74377,7 +76087,7 @@ paths: description: Response content: application/json: - schema: *527 + schema: *544 examples: response: summary: application/json response @@ -74431,14 +76141,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *515 + '403': *532 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74518,8 +76228,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: - - *430 - - *431 + - *447 + - *448 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74575,9 +76285,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': *521 + '403': *538 '404': *6 - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74597,8 +76307,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -74606,7 +76316,7 @@ paths: application/json: schema: type: array - items: &528 + items: &545 title: CodeQL Database description: A CodeQL database. type: object @@ -74718,9 +76428,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': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74747,8 +76457,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: - - *430 - - *431 + - *447 + - *448 - name: language in: path description: The language of the CodeQL database. @@ -74760,7 +76470,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *545 examples: default: value: @@ -74792,11 +76502,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': &558 + '302': &575 description: Found - '403': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74816,8 +76526,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *430 - - *431 + - *447 + - *448 - name: language in: path description: The language of the CodeQL database. @@ -74827,9 +76537,9 @@ paths: responses: '204': description: Response - '403': *521 + '403': *538 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74855,8 +76565,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -74865,7 +76575,7 @@ paths: type: object additionalProperties: false properties: - language: &529 + language: &546 type: string description: The language targeted by the CodeQL query enum: @@ -74944,7 +76654,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &533 + schema: &550 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -74952,9 +76662,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *108 + controller_repo: *113 actor: *4 - query_language: *529 + query_language: *546 query_pack_url: type: string description: The download url for the query pack. @@ -75002,7 +76712,7 @@ paths: items: type: object properties: - repository: &530 + repository: &547 title: Repository Identifier description: Repository Identifier type: object @@ -75044,7 +76754,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &534 + analysis_status: &551 type: string description: The new status of the CodeQL variant analysis repository task. @@ -75076,7 +76786,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &531 + access_mismatch_repos: &548 type: object properties: repository_count: @@ -75091,7 +76801,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: *530 + items: *547 required: - repository_count - repositories @@ -75114,8 +76824,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *531 - over_limit_repos: *531 + no_codeql_db_repos: *548 + over_limit_repos: *548 required: - access_mismatch_repos - not_found_repos @@ -75131,7 +76841,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &532 + value: &549 summary: Default response value: id: 1 @@ -75283,17 +76993,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *532 + value: *549 repository_lists: summary: Response for a successful variant analysis submission - value: *532 + value: *549 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75314,8 +77024,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: - - *430 - - *431 + - *447 + - *448 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -75327,11 +77037,11 @@ paths: description: Response content: application/json: - schema: *533 + schema: *550 examples: - default: *532 + default: *549 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75352,7 +77062,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: - - *430 + - *447 - name: repo in: path description: The name of the controller repository. @@ -75386,8 +77096,8 @@ paths: schema: type: object properties: - repository: *108 - analysis_status: *534 + repository: *113 + analysis_status: *551 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -75491,7 +77201,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75512,8 +77222,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -75606,9 +77316,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *515 + '403': *532 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75627,8 +77337,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -75697,7 +77407,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -75722,7 +77432,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *521 + '403': *538 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -75736,7 +77446,7 @@ paths: content: application/json: schema: *3 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75793,8 +77503,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -75802,7 +77512,7 @@ paths: schema: type: object properties: - commit_sha: *535 + commit_sha: *552 ref: type: string description: |- @@ -75862,7 +77572,7 @@ paths: schema: type: object properties: - id: *526 + id: *543 url: type: string description: The REST API URL for checking the status of the upload. @@ -75876,11 +77586,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': *521 + '403': *538 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -75899,8 +77609,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: - - *430 - - *431 + - *447 + - *448 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -75948,10 +77658,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': *515 + '403': *532 '404': description: Not Found if the sarif id does not match any upload - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -75973,8 +77683,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -75998,7 +77708,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *103 + configuration: *108 examples: default: value: @@ -76030,7 +77740,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': *129 + '204': *139 '304': *35 '403': *27 '404': *6 @@ -76055,8 +77765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *430 - - *431 + - *447 + - *448 - 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 @@ -76184,8 +77894,8 @@ paths: parameters: - *17 - *19 - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -76201,7 +77911,7 @@ paths: type: integer codespaces: type: array - items: *336 + items: *354 examples: default: value: @@ -76499,8 +78209,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -76564,22 +78274,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76603,8 +78313,8 @@ paths: parameters: - *17 - *19 - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -76668,8 +78378,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: - - *430 - - *431 + - *447 + - *448 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -76706,9 +78416,9 @@ paths: type: integer machines: type: array - items: *537 + items: *554 examples: - default: &771 + default: &790 value: total_count: 2 machines: @@ -76748,8 +78458,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *430 - - *431 + - *447 + - *448 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -76836,8 +78546,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: - - *430 - - *431 + - *447 + - *448 - 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 @@ -76885,7 +78595,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76906,8 +78616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -76925,7 +78635,7 @@ paths: type: integer secrets: type: array - items: &541 + items: &558 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -76946,7 +78656,7 @@ paths: - created_at - updated_at examples: - default: *538 + default: *555 headers: Link: *41 x-github: @@ -76969,16 +78679,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *539 + schema: *556 examples: - default: *540 + default: *557 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76998,17 +78708,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '200': description: Response content: application/json: - schema: *541 + schema: *558 examples: - default: *542 + default: *559 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77028,9 +78738,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: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 requestBody: required: true content: @@ -77058,7 +78768,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -77082,9 +78792,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '204': description: Response @@ -77112,8 +78822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *430 - - *431 + - *447 + - *448 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -77151,7 +78861,7 @@ paths: application/json: schema: type: array - items: &543 + items: &560 title: Collaborator description: Collaborator type: object @@ -77344,9 +79054,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: - - *430 - - *431 - - *178 + - *447 + - *448 + - *194 responses: '204': description: Response if user is a collaborator @@ -77392,9 +79102,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *430 - - *431 - - *178 + - *447 + - *448 + - *194 requestBody: required: false content: @@ -77420,7 +79130,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &616 + schema: &633 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -77432,7 +79142,7 @@ paths: format: int64 examples: - 42 - repository: *246 + repository: *266 invitee: anyOf: - type: 'null' @@ -77608,7 +79318,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *223 + schema: *241 '403': *27 x-github: triggersNotification: true @@ -77648,9 +79358,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *430 - - *431 - - *178 + - *447 + - *448 + - *194 responses: '204': description: No Content when collaborator was removed from the repository. @@ -77681,9 +79391,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *430 - - *431 - - *178 + - *447 + - *448 + - *194 responses: '200': description: if user has admin permissions @@ -77703,7 +79413,7 @@ paths: user: anyOf: - type: 'null' - - *543 + - *560 required: - permission - role_name @@ -77757,8 +79467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -77768,7 +79478,7 @@ paths: application/json: schema: type: array - items: &544 + items: &561 title: Commit Comment description: Commit Comment type: object @@ -77809,8 +79519,8 @@ paths: updated_at: type: string format: date-time - author_association: *184 - reactions: *185 + author_association: *201 + reactions: *202 required: - url - html_url @@ -77826,7 +79536,7 @@ paths: - created_at - updated_at examples: - default: &547 + default: &564 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77885,17 +79595,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '200': description: Response content: application/json: - schema: *544 + schema: *561 examples: - default: &548 + default: &565 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77952,9 +79662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -77976,7 +79686,7 @@ paths: description: Response content: application/json: - schema: *544 + schema: *561 examples: default: value: @@ -78027,9 +79737,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '204': description: Response @@ -78050,9 +79760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 - 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. @@ -78078,9 +79788,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 '404': *6 @@ -78101,9 +79811,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -78135,16 +79845,16 @@ paths: description: Reaction exists content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Reaction created content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '422': *15 x-github: githubCloudOnly: false @@ -78166,10 +79876,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *430 - - *431 - - *198 - - *422 + - *447 + - *448 + - *215 + - *439 responses: '204': description: Response @@ -78218,8 +79928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *430 - - *431 + - *447 + - *448 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -78275,9 +79985,9 @@ paths: application/json: schema: type: array - items: *545 + items: *562 examples: - default: &662 + default: &681 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78351,7 +80061,7 @@ paths: '500': *38 '400': *14 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78371,9 +80081,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *430 - - *431 - - &546 + - *447 + - *448 + - &563 name: commit_sha description: The SHA of the commit. in: path @@ -78420,7 +80130,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78445,9 +80155,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *430 - - *431 - - *546 + - *447 + - *448 + - *563 - *17 - *19 responses: @@ -78457,9 +80167,9 @@ paths: application/json: schema: type: array - items: *544 + items: *561 examples: - default: *547 + default: *564 headers: Link: *41 x-github: @@ -78487,9 +80197,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *430 - - *431 - - *546 + - *447 + - *448 + - *563 requestBody: required: true content: @@ -78524,9 +80234,9 @@ paths: description: Response content: application/json: - schema: *544 + schema: *561 examples: - default: *548 + default: *565 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78554,9 +80264,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: - - *430 - - *431 - - *546 + - *447 + - *448 + - *563 - *17 - *19 responses: @@ -78566,9 +80276,9 @@ paths: application/json: schema: type: array - items: *549 + items: *566 examples: - default: &654 + default: &673 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -79048,7 +80758,7 @@ paths: draft: false headers: Link: *41 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79105,11 +80815,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *430 - - *431 + - *447 + - *448 - *19 - *17 - - &550 + - &567 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)" @@ -79124,9 +80834,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *562 examples: - default: &642 + default: &659 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -79213,8 +80923,8 @@ paths: '422': *15 '404': *6 '500': *38 - '503': *163 - '409': *107 + '503': *179 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79239,11 +80949,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: - - *430 - - *431 - - *550 - - *551 - - *552 + - *447 + - *448 + - *567 + - *568 + - *569 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -79277,9 +80987,9 @@ paths: type: integer check_runs: type: array - items: *500 + items: *517 examples: - default: *553 + default: *570 headers: Link: *41 x-github: @@ -79304,9 +81014,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: - - *430 - - *431 - - *550 + - *447 + - *448 + - *567 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -79314,7 +81024,7 @@ paths: schema: type: integer example: 1 - - *551 + - *568 - *17 - *19 responses: @@ -79332,7 +81042,7 @@ paths: type: integer check_suites: type: array - items: *504 + items: *521 examples: default: value: @@ -79532,9 +81242,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: - - *430 - - *431 - - *550 + - *447 + - *448 + - *567 - *17 - *19 responses: @@ -79605,7 +81315,7 @@ paths: type: string total_count: type: integer - repository: *246 + repository: *266 commit_url: type: string format: uri @@ -79736,9 +81446,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *430 - - *431 - - *550 + - *447 + - *448 + - *567 - *17 - *19 responses: @@ -79748,7 +81458,7 @@ paths: application/json: schema: type: array - items: &716 + items: &735 title: Status description: The status of a commit. type: object @@ -79829,7 +81539,7 @@ paths: site_admin: false headers: Link: *41 - '301': *444 + '301': *461 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79857,8 +81567,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -79891,11 +81601,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *554 + - *571 code_of_conduct_file: anyOf: - type: 'null' - - &555 + - &572 title: Community Health File type: object properties: @@ -79911,23 +81621,23 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 contributing: anyOf: - type: 'null' - - *555 + - *572 readme: anyOf: - type: 'null' - - *555 + - *572 issue_template: anyOf: - type: 'null' - - *555 + - *572 pull_request_template: anyOf: - type: 'null' - - *555 + - *572 required: - code_of_conduct - code_of_conduct_file @@ -80056,8 +81766,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *430 - - *431 + - *447 + - *448 - *19 - *17 - name: basehead @@ -80105,8 +81815,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *545 - merge_base_commit: *545 + base_commit: *562 + merge_base_commit: *562 status: type: string enum: @@ -80130,10 +81840,10 @@ paths: - 6 commits: type: array - items: *545 + items: *562 files: type: array - items: *556 + items: *573 required: - url - html_url @@ -80377,7 +82087,7 @@ paths: module Test" '404': *6 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80419,8 +82129,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *430 - - *431 + - *447 + - *448 - name: path description: path parameter in: path @@ -80573,7 +82283,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &557 + response-if-content-is-a-file: &574 summary: Response if content is a file value: type: file @@ -80710,7 +82420,7 @@ paths: - size - type - url - - &667 + - &686 title: Content File description: Content File type: object @@ -80928,7 +82638,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *557 + response-if-content-is-a-file: *574 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -80997,7 +82707,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *558 + '302': *575 '304': *35 x-github: githubCloudOnly: false @@ -81020,8 +82730,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *430 - - *431 + - *447 + - *448 - name: path description: path parameter in: path @@ -81116,7 +82826,7 @@ paths: description: Response content: application/json: - schema: &559 + schema: &576 title: File Commit description: File Commit type: object @@ -81272,7 +82982,7 @@ paths: description: Response content: application/json: - schema: *559 + schema: *576 examples: example-for-creating-a-file: value: @@ -81326,7 +83036,7 @@ paths: schema: oneOf: - *3 - - &598 + - &615 description: Repository rule violation was detected type: object properties: @@ -81347,7 +83057,7 @@ paths: items: type: object properties: - placeholder_id: &708 + placeholder_id: &727 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -81379,8 +83089,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *430 - - *431 + - *447 + - *448 - name: path description: path parameter in: path @@ -81441,7 +83151,7 @@ paths: description: Response content: application/json: - schema: *559 + schema: *576 examples: default: value: @@ -81475,8 +83185,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *107 - '503': *163 + '409': *112 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81496,8 +83206,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *430 - - *431 + - *447 + - *448 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -81621,31 +83331,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *430 - - *431 - - *294 - - *295 - - *296 - - *297 + - *447 + - *448 + - *314 + - *315 + - *316 + - *317 - 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 - - *298 - - *560 - - *299 - - *300 - - *99 - - 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 + - *318 + - *577 + - *319 + - *320 + - *104 - 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)." @@ -81654,10 +83356,8 @@ paths: schema: type: integer default: 30 - - *97 - - *98 - - *301 - - *302 + - *102 + - *103 responses: '200': description: Response @@ -81665,11 +83365,11 @@ paths: application/json: schema: type: array - items: &563 + items: &580 type: object description: A Dependabot alert. properties: - number: *109 + number: *119 state: type: string description: The state of the Dependabot alert. @@ -81684,7 +83384,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *110 + package: *120 manifest_path: type: string description: The full path to the dependency manifest file, @@ -81715,13 +83415,13 @@ paths: - direct - transitive - - security_advisory: *561 - security_vulnerability: *113 - url: *114 - html_url: *115 - created_at: *116 - updated_at: *117 - dismissed_at: *118 + security_advisory: *578 + security_vulnerability: *123 + url: *124 + html_url: *125 + created_at: *126 + updated_at: *127 + dismissed_at: *128 dismissed_by: anyOf: - type: 'null' @@ -81745,8 +83445,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *119 - auto_dismissed_at: *562 + fixed_at: *129 + auto_dismissed_at: *579 required: - number - state @@ -81976,9 +83676,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *430 - - *431 - - &564 + - *447 + - *448 + - &581 name: alert_number in: path description: |- @@ -81987,13 +83687,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *109 + schema: *119 responses: '200': description: Response content: application/json: - schema: *563 + schema: *580 examples: default: value: @@ -82106,9 +83806,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *430 - - *431 - - *564 + - *447 + - *448 + - *581 requestBody: required: true content: @@ -82153,7 +83853,7 @@ paths: description: Response content: application/json: - schema: *563 + schema: *580 examples: default: value: @@ -82259,7 +83959,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *107 + '409': *112 '422': *7 x-github: githubCloudOnly: false @@ -82282,8 +83982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -82301,7 +84001,7 @@ paths: type: integer secrets: type: array - items: &567 + items: &584 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -82355,16 +84055,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *565 + schema: *582 examples: - default: *566 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82384,15 +84084,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '200': description: Response content: application/json: - schema: *567 + schema: *584 examples: default: value: @@ -82418,9 +84118,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 requestBody: required: true content: @@ -82448,7 +84148,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -82472,9 +84172,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *430 - - *431 - - *256 + - *447 + - *448 + - *276 responses: '204': description: Response @@ -82496,8 +84196,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: - - *430 - - *431 + - *447 + - *448 - 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 @@ -82671,8 +84371,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -82932,8 +84632,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -83016,7 +84716,7 @@ paths: - version - url additionalProperties: false - metadata: &568 + metadata: &585 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -83055,7 +84755,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *568 + metadata: *585 resolved: type: object description: A collection of resolved package dependencies. @@ -83069,7 +84769,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *568 + metadata: *585 relationship: type: string description: A notation of whether a dependency is requested @@ -83202,8 +84902,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *430 - - *431 + - *447 + - *448 - name: sha description: The SHA recorded at creation time. in: query @@ -83244,9 +84944,9 @@ paths: application/json: schema: type: array - items: *569 + items: *586 examples: - default: *570 + default: *587 headers: Link: *41 x-github: @@ -83312,8 +85012,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -83395,7 +85095,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *586 examples: simple-example: summary: Simple example @@ -83468,9 +85168,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *430 - - *431 - - &571 + - *447 + - *448 + - &588 name: deployment_id description: deployment_id parameter in: path @@ -83482,7 +85182,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *586 examples: default: value: @@ -83547,9 +85247,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *430 - - *431 - - *571 + - *447 + - *448 + - *588 responses: '204': description: Response @@ -83571,9 +85271,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *430 - - *431 - - *571 + - *447 + - *448 + - *588 - *17 - *19 responses: @@ -83583,7 +85283,7 @@ paths: application/json: schema: type: array - items: &572 + items: &589 title: Deployment Status description: The status of a deployment. type: object @@ -83747,9 +85447,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *430 - - *431 - - *571 + - *447 + - *448 + - *588 requestBody: required: true content: @@ -83824,9 +85524,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *589 examples: - default: &573 + default: &590 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83882,9 +85582,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *430 - - *431 - - *571 + - *447 + - *448 + - *588 - name: status_id in: path required: true @@ -83895,9 +85595,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *589 examples: - default: *573 + default: *590 '404': *6 x-github: githubCloudOnly: false @@ -83924,12 +85624,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 - - *574 - - *575 - - *576 - - *577 + - *447 + - *448 + - *591 + - *592 + - *593 + - *594 - *17 - *19 responses: @@ -83939,9 +85639,9 @@ paths: application/json: schema: type: array - items: *578 + items: *595 examples: - default: *579 + default: *596 '404': *6 '403': *27 '500': *38 @@ -83965,8 +85665,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: alert_number in: path required: true @@ -83978,7 +85678,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *578 + schema: *595 examples: default: value: @@ -84034,8 +85734,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: alert_number in: path required: true @@ -84094,12 +85794,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 - - *92 - - *93 - - *94 - - *580 + - *447 + - *448 + - *97 + - *98 + - *99 + - *597 - *17 - *19 responses: @@ -84109,9 +85809,9 @@ paths: application/json: schema: type: array - items: *581 + items: *598 examples: - default: *582 + default: *599 '404': *6 '403': *27 '500': *38 @@ -84136,8 +85836,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: alert_number in: path required: true @@ -84149,7 +85849,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *581 + schema: *598 examples: default: value: @@ -84207,8 +85907,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: alert_number in: path required: true @@ -84277,8 +85977,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -84335,8 +86035,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -84354,7 +86054,7 @@ paths: - 5 environments: type: array - items: &584 + items: &601 title: Environment description: Details of a deployment environment type: object @@ -84416,7 +86116,7 @@ paths: type: string examples: - wait_timer - wait_timer: &586 + wait_timer: &603 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -84458,11 +86158,11 @@ paths: items: type: object properties: - type: *583 + type: *600 reviewer: anyOf: - *4 - - *273 + - *293 required: - id - node_id @@ -84485,7 +86185,7 @@ paths: - id - node_id - type - deployment_branch_policy: &587 + deployment_branch_policy: &604 type: - object - 'null' @@ -84602,9 +86302,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *430 - - *431 - - &585 + - *447 + - *448 + - &602 name: environment_name in: path required: true @@ -84617,9 +86317,9 @@ paths: description: Response content: application/json: - schema: *584 + schema: *601 examples: - default: &588 + default: &605 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -84703,9 +86403,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 requestBody: required: false content: @@ -84715,7 +86415,7 @@ paths: - object - 'null' properties: - wait_timer: *586 + wait_timer: *603 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -84734,14 +86434,14 @@ paths: items: type: object properties: - type: *583 + type: *600 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *587 + deployment_branch_policy: *604 additionalProperties: false examples: default: @@ -84761,9 +86461,9 @@ paths: description: Response content: application/json: - schema: *584 + schema: *601 examples: - default: *588 + default: *605 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -84787,9 +86487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 responses: '204': description: Default response @@ -84814,9 +86514,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 - *17 - *19 responses: @@ -84835,7 +86535,7 @@ paths: - 2 branch_policies: type: array - items: &589 + items: &606 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -84896,9 +86596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 requestBody: required: true content: @@ -84946,9 +86646,9 @@ paths: description: Response content: application/json: - schema: *589 + schema: *606 examples: - example-wildcard: &590 + example-wildcard: &607 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -84990,10 +86690,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *430 - - *431 - - *585 - - &591 + - *447 + - *448 + - *602 + - &608 name: branch_policy_id in: path required: true @@ -85005,9 +86705,9 @@ paths: description: Response content: application/json: - schema: *589 + schema: *606 examples: - default: *590 + default: *607 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85026,10 +86726,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *430 - - *431 - - *585 - - *591 + - *447 + - *448 + - *602 + - *608 requestBody: required: true content: @@ -85058,9 +86758,9 @@ paths: description: Response content: application/json: - schema: *589 + schema: *606 examples: - default: *590 + default: *607 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85079,10 +86779,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *430 - - *431 - - *585 - - *591 + - *447 + - *448 + - *602 + - *608 responses: '204': description: Response @@ -85107,9 +86807,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: - - *585 - - *431 - - *430 + - *602 + - *448 + - *447 responses: '200': description: List of deployment protection rules @@ -85126,7 +86826,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &592 + items: &609 title: Deployment protection rule description: Deployment protection rule type: object @@ -85148,7 +86848,7 @@ paths: for the environment. examples: - true - app: &593 + app: &610 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -85251,9 +86951,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: - - *585 - - *431 - - *430 + - *602 + - *448 + - *447 requestBody: content: application/json: @@ -85274,9 +86974,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *592 + schema: *609 examples: - default: &594 + default: &611 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -85311,9 +87011,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: - - *585 - - *431 - - *430 + - *602 + - *448 + - *447 - *19 - *17 responses: @@ -85333,7 +87033,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *593 + items: *610 examples: default: value: @@ -85368,10 +87068,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: - - *430 - - *431 - - *585 - - &595 + - *447 + - *448 + - *602 + - &612 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -85383,9 +87083,9 @@ paths: description: Response content: application/json: - schema: *592 + schema: *609 examples: - default: *594 + default: *611 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85406,10 +87106,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: - - *585 - - *431 - - *430 - - *595 + - *602 + - *448 + - *447 + - *612 responses: '204': description: Response @@ -85435,9 +87135,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 - *17 - *19 responses: @@ -85455,9 +87155,9 @@ paths: type: integer secrets: type: array - items: *467 + items: *484 examples: - default: *468 + default: *485 headers: Link: *41 x-github: @@ -85482,17 +87182,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 responses: '200': description: Response content: application/json: - schema: *469 + schema: *486 examples: - default: *470 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85514,18 +87214,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *430 - - *431 - - *585 - - *256 + - *447 + - *448 + - *602 + - *276 responses: '200': description: Response content: application/json: - schema: *467 + schema: *484 examples: - default: *596 + default: *613 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85547,10 +87247,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *430 - - *431 - - *585 - - *256 + - *447 + - *448 + - *602 + - *276 requestBody: required: true content: @@ -85581,7 +87281,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -85607,10 +87307,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *430 - - *431 - - *585 - - *256 + - *447 + - *448 + - *602 + - *276 responses: '204': description: Default response @@ -85635,10 +87335,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *430 - - *431 - - *585 - - *454 + - *447 + - *448 + - *602 + - *471 - *19 responses: '200': @@ -85655,9 +87355,9 @@ paths: type: integer variables: type: array - items: *471 + items: *488 examples: - default: *472 + default: *489 headers: Link: *41 x-github: @@ -85680,9 +87380,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *430 - - *431 - - *585 + - *447 + - *448 + - *602 requestBody: required: true content: @@ -85709,7 +87409,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -85734,18 +87434,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *430 - - *431 - - *585 - - *259 + - *447 + - *448 + - *602 + - *279 responses: '200': description: Response content: application/json: - schema: *471 + schema: *488 examples: - default: *597 + default: *614 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85766,10 +87466,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *430 - - *431 - - *259 - - *585 + - *447 + - *448 + - *279 + - *602 requestBody: required: true content: @@ -85811,10 +87511,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *430 - - *431 - - *259 - - *585 + - *447 + - *448 + - *279 + - *602 responses: '204': description: Response @@ -85836,8 +87536,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -85847,7 +87547,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: 200-response: value: @@ -85905,8 +87605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *430 - - *431 + - *447 + - *448 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -85928,7 +87628,7 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: default: value: @@ -86065,8 +87765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -86099,9 +87799,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - default: *445 + default: *462 '400': *14 '422': *15 '403': *27 @@ -86122,8 +87822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -86174,7 +87874,7 @@ paths: schema: type: string '404': *6 - '409': *107 + '409': *112 '403': *27 '422': description: Validation failed @@ -86182,8 +87882,8 @@ paths: application/json: schema: oneOf: - - *223 - - *598 + - *241 + - *615 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86208,8 +87908,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *430 - - *431 + - *447 + - *448 - name: file_sha in: path required: true @@ -86261,7 +87961,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86309,8 +88009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -86419,7 +88119,7 @@ paths: description: Response content: application/json: - schema: &599 + schema: &616 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -86596,7 +88296,7 @@ paths: type: string '422': *15 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86646,15 +88346,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *430 - - *431 - - *546 + - *447 + - *448 + - *563 responses: '200': description: Response content: application/json: - schema: *599 + schema: *616 examples: default: value: @@ -86685,7 +88385,7 @@ paths: payload: verified_at: '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86710,9 +88410,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *430 - - *431 - - &600 + - *447 + - *448 + - &617 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. @@ -86729,7 +88429,7 @@ paths: application/json: schema: type: array - items: &601 + items: &618 title: Git Reference description: Git references within a repository type: object @@ -86784,7 +88484,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *41 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86805,17 +88505,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *430 - - *431 - - *600 + - *447 + - *448 + - *617 responses: '200': description: Response content: application/json: - schema: *601 + schema: *618 examples: - default: &602 + default: &619 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -86825,7 +88525,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86844,8 +88544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -86874,16 +88574,16 @@ paths: description: Response content: application/json: - schema: *601 + schema: *618 examples: - default: *602 + default: *619 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86902,9 +88602,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *430 - - *431 - - *600 + - *447 + - *448 + - *617 requestBody: required: true content: @@ -86933,11 +88633,11 @@ paths: description: Response content: application/json: - schema: *601 + schema: *618 examples: - default: *602 + default: *619 '422': *15 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86953,16 +88653,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *430 - - *431 - - *600 + - *447 + - *448 + - *617 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87010,8 +88710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -87078,7 +88778,7 @@ paths: description: Response content: application/json: - schema: &604 + schema: &621 title: Git Tag description: Metadata for a Git tag type: object @@ -87134,7 +88834,7 @@ paths: - sha - type - url - verification: *603 + verification: *620 required: - sha - url @@ -87144,7 +88844,7 @@ paths: - tag - message examples: - default: &605 + default: &622 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -87171,7 +88871,7 @@ paths: schema: type: string '422': *15 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87217,8 +88917,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *430 - - *431 + - *447 + - *448 - name: tag_sha in: path required: true @@ -87229,11 +88929,11 @@ paths: description: Response content: application/json: - schema: *604 + schema: *621 examples: - default: *605 + default: *622 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87255,8 +88955,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -87330,7 +89030,7 @@ paths: description: Response content: application/json: - schema: &606 + schema: &623 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -87409,7 +89109,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87432,8 +89132,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *430 - - *431 + - *447 + - *448 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -87456,7 +89156,7 @@ paths: description: Response content: application/json: - schema: *606 + schema: *623 examples: default-response: summary: Default response @@ -87497,7 +89197,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87515,8 +89215,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -87526,7 +89226,7 @@ paths: application/json: schema: type: array - items: &607 + items: &624 title: Webhook description: Webhooks for repositories. type: object @@ -87589,7 +89289,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &849 + last_response: &867 title: Hook Response type: object properties: @@ -87666,8 +89366,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -87720,9 +89420,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *624 examples: - default: &608 + default: &625 value: type: Repository id: 12345678 @@ -87770,17 +89470,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 responses: '200': description: Response content: application/json: - schema: *607 + schema: *624 examples: - default: *608 + default: *625 '404': *6 x-github: githubCloudOnly: false @@ -87800,9 +89500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 requestBody: required: true content: @@ -87847,9 +89547,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *624 examples: - default: *608 + default: *625 '422': *15 '404': *6 x-github: @@ -87870,9 +89570,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 responses: '204': description: Response @@ -87896,9 +89596,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: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 responses: '200': description: Response @@ -87925,9 +89625,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: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 requestBody: required: false content: @@ -87971,11 +89671,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 - *17 - - *309 + - *327 responses: '200': description: Response @@ -87983,9 +89683,9 @@ paths: application/json: schema: type: array - items: *310 + items: *328 examples: - default: *311 + default: *329 '400': *14 '422': *15 x-github: @@ -88004,18 +89704,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: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 - *16 responses: '200': description: Response content: application/json: - schema: *312 + schema: *330 examples: - default: *313 + default: *331 '400': *14 '422': *15 x-github: @@ -88034,9 +89734,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: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 - *16 responses: '202': *37 @@ -88059,9 +89759,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 responses: '204': description: Response @@ -88086,9 +89786,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *430 - - *431 - - *308 + - *447 + - *448 + - *326 responses: '204': description: Response @@ -88111,8 +89811,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response if immutable releases are enabled @@ -88160,11 +89860,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *430 - - *431 + - *447 + - *448 responses: - '204': *129 - '409': *107 + '204': *139 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88181,11 +89881,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *430 - - *431 + - *447 + - *448 responses: - '204': *129 - '409': *107 + '204': *139 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88239,14 +89939,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: &609 + schema: &626 title: Import description: A repository import from an external source. type: object @@ -88353,7 +90053,7 @@ paths: - html_url - authors_url examples: - default: &612 + default: &629 value: vcs: subversion use_lfs: true @@ -88369,7 +90069,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': &610 + '503': &627 description: Unavailable due to service under maintenance. content: application/json: @@ -88398,8 +90098,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -88447,7 +90147,7 @@ paths: description: Response content: application/json: - schema: *609 + schema: *626 examples: default: value: @@ -88472,7 +90172,7 @@ paths: type: string '422': *15 '404': *6 - '503': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88500,8 +90200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -88553,7 +90253,7 @@ paths: description: Response content: application/json: - schema: *609 + schema: *626 examples: example-1: summary: Example 1 @@ -88601,7 +90301,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': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88624,12 +90324,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response - '503': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88655,9 +90355,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *430 - - *431 - - &793 + - *447 + - *448 + - &811 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -88671,7 +90371,7 @@ paths: application/json: schema: type: array - items: &611 + items: &628 title: Porter Author description: Porter Author type: object @@ -88725,7 +90425,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': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88750,8 +90450,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *430 - - *431 + - *447 + - *448 - name: author_id in: path required: true @@ -88781,7 +90481,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *628 examples: default: value: @@ -88794,7 +90494,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88818,8 +90518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -88860,7 +90560,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88888,8 +90588,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -88916,11 +90616,11 @@ paths: description: Response content: application/json: - schema: *609 + schema: *626 examples: - default: *612 + default: *629 '422': *15 - '503': *610 + '503': *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88943,8 +90643,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -88952,8 +90652,8 @@ paths: application/json: schema: *20 examples: - default: *613 - '301': *444 + default: *630 + '301': *461 '404': *6 x-github: githubCloudOnly: false @@ -88973,8 +90673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -88982,12 +90682,12 @@ paths: application/json: schema: anyOf: - - *326 + - *344 - type: object properties: {} additionalProperties: false examples: - default: &615 + default: &632 value: limit: collaborators_only origin: repository @@ -89012,13 +90712,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: application/json: - schema: *614 + schema: *631 examples: default: summary: Example request body @@ -89030,9 +90730,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *344 examples: - default: *615 + default: *632 '409': description: Response x-github: @@ -89054,8 +90754,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -89078,8 +90778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -89089,9 +90789,9 @@ paths: application/json: schema: type: array - items: *616 + items: *633 examples: - default: &786 + default: &804 value: - id: 1 repository: @@ -89222,9 +90922,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *430 - - *431 - - *330 + - *447 + - *448 + - *348 requestBody: required: false content: @@ -89253,7 +90953,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *633 examples: default: value: @@ -89384,9 +91084,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *430 - - *431 - - *330 + - *447 + - *448 + - *348 responses: '204': description: Response @@ -89417,8 +91117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *430 - - *431 + - *447 + - *448 - 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 @@ -89466,7 +91166,7 @@ paths: required: false schema: type: string - - *334 + - *352 - name: sort description: What to sort results by. in: query @@ -89478,8 +91178,8 @@ paths: - updated - comments default: created - - *99 - - *189 + - *104 + - *206 - *17 - *19 responses: @@ -89489,9 +91189,9 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: &623 + default: &640 value: - id: 1 node_id: MDU6SXNzdWUx @@ -89639,7 +91339,7 @@ paths: state_reason: completed headers: Link: *41 - '301': *444 + '301': *461 '422': *15 '404': *6 x-github: @@ -89668,8 +91368,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -89759,9 +91459,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: &620 + default: &637 value: id: 1 node_id: MDU6SXNzdWUx @@ -89915,9 +91615,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *163 + '503': *179 '404': *6 - '410': *441 + '410': *458 x-github: triggersNotification: true githubCloudOnly: false @@ -89945,9 +91645,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *430 - - *431 - - *206 + - *447 + - *448 + - *223 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -89957,7 +91657,7 @@ paths: enum: - asc - desc - - *189 + - *206 - *17 - *19 responses: @@ -89967,9 +91667,9 @@ paths: application/json: schema: type: array - items: *617 + items: *634 examples: - default: &622 + default: &639 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -90027,17 +91727,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '200': description: Response content: application/json: - schema: *617 + schema: *634 examples: - default: &618 + default: &635 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -90091,9 +91791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -90115,9 +91815,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *634 examples: - default: *618 + default: *635 '422': *15 x-github: githubCloudOnly: false @@ -90135,9 +91835,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '204': description: Response @@ -90157,9 +91857,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 - 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. @@ -90185,9 +91885,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 '404': *6 @@ -90208,9 +91908,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -90242,16 +91942,16 @@ paths: description: Reaction exists content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Reaction created content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '422': *15 x-github: githubCloudOnly: false @@ -90273,10 +91973,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *430 - - *431 - - *198 - - *422 + - *447 + - *448 + - *215 + - *439 responses: '204': description: Response @@ -90296,8 +91996,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -90307,7 +92007,7 @@ paths: application/json: schema: type: array - items: &619 + items: &636 title: Issue Event description: Issue Event type: object @@ -90354,7 +92054,7 @@ paths: issue: anyOf: - type: 'null' - - *183 + - *200 label: title: Issue Event Label description: Issue Event Label @@ -90387,7 +92087,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *273 + requested_team: *293 dismissed_review: title: Issue Event Dismissed Review type: object @@ -90454,7 +92154,7 @@ paths: required: - from - to - author_association: *184 + author_association: *201 lock_reason: type: - string @@ -90646,8 +92346,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *430 - - *431 + - *447 + - *448 - name: event_id in: path required: true @@ -90658,7 +92358,7 @@ paths: description: Response content: application/json: - schema: *619 + schema: *636 examples: default: value: @@ -90851,7 +92551,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *441 + '410': *458 '403': *27 x-github: githubCloudOnly: false @@ -90885,9 +92585,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *430 - - *431 - - &621 + - *447 + - *448 + - &638 name: issue_number description: The number that identifies the issue. in: path @@ -90899,12 +92599,12 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 - '301': *444 + default: *637 + '301': *461 '404': *6 - '410': *441 + '410': *458 '304': *35 x-github: githubCloudOnly: false @@ -90929,9 +92629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: false content: @@ -91050,15 +92750,15 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 '422': *15 - '503': *163 + '503': *179 '403': *27 - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91076,9 +92776,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: false content: @@ -91104,9 +92804,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91122,9 +92822,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: content: application/json: @@ -91149,9 +92849,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91173,9 +92873,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: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - name: assignee in: path required: true @@ -91215,10 +92915,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *430 - - *431 - - *621 - - *189 + - *447 + - *448 + - *638 + - *206 - *17 - *19 responses: @@ -91228,13 +92928,13 @@ paths: application/json: schema: type: array - items: *617 + items: *634 examples: - default: *622 + default: *639 headers: Link: *41 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91263,9 +92963,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -91287,16 +92987,16 @@ paths: description: Response content: application/json: - schema: *617 + schema: *634 examples: - default: *618 + default: *635 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *441 + '410': *458 '422': *15 '404': *6 x-github: @@ -91324,9 +93024,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: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -91336,14 +93036,14 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: *623 + default: *640 headers: Link: *41 - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91371,9 +93071,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: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -91395,17 +93095,17 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *444 + '301': *461 '403': *27 - '410': *441 + '410': *458 '422': *15 '404': *6 x-github: @@ -91436,9 +93136,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: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -91450,15 +93150,15 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 - '301': *444 + default: *637 + '301': *461 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *441 + '410': *458 x-github: triggersNotification: true githubCloudOnly: false @@ -91484,9 +93184,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: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -91496,14 +93196,14 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: *623 + default: *640 headers: Link: *41 - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91520,9 +93220,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -91536,7 +93236,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &625 + - &642 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -91585,7 +93285,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &626 + - &643 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -91713,7 +93413,7 @@ paths: - performed_via_github_app - assignee - assigner - - &627 + - &644 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91759,7 +93459,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &628 + - &645 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91805,7 +93505,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &629 + - &646 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91854,7 +93554,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &630 + - &647 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91883,7 +93583,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *273 + requested_team: *293 requested_reviewer: *4 required: - review_requester @@ -91896,7 +93596,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &631 + - &648 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91925,7 +93625,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *273 + requested_team: *293 requested_reviewer: *4 required: - review_requester @@ -91938,7 +93638,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &632 + - &649 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91994,7 +93694,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &633 + - &650 title: Locked Issue Event description: Locked Issue Event type: object @@ -92039,7 +93739,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &634 + - &651 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -92100,7 +93800,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &635 + - &652 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -92161,7 +93861,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &636 + - &653 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -92222,7 +93922,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &637 + - &654 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -92315,7 +94015,7 @@ paths: color: red headers: Link: *41 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92332,9 +94032,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -92344,9 +94044,9 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: - default: &624 + default: &641 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -92364,9 +94064,9 @@ paths: default: false headers: Link: *41 - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92383,9 +94083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: false content: @@ -92444,12 +94144,12 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: - default: *624 - '301': *444 + default: *641 + '301': *461 '404': *6 - '410': *441 + '410': *458 '422': *15 x-github: githubCloudOnly: false @@ -92466,9 +94166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: false content: @@ -92528,12 +94228,12 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: - default: *624 - '301': *444 + default: *641 + '301': *461 '404': *6 - '410': *441 + '410': *458 '422': *15 x-github: githubCloudOnly: false @@ -92550,15 +94250,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 responses: '204': description: Response - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92577,9 +94277,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - name: name in: path required: true @@ -92592,7 +94292,7 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: default: value: @@ -92603,9 +94303,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *444 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92625,9 +94325,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: false content: @@ -92656,7 +94356,7 @@ paths: '204': description: Response '403': *27 - '410': *441 + '410': *458 '404': *6 '422': *15 x-github: @@ -92674,9 +94374,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 responses: '204': description: Response @@ -92706,20 +94406,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 responses: '200': description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 - '301': *444 + default: *637 + '301': *461 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92736,9 +94436,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - 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. @@ -92764,13 +94464,13 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92788,9 +94488,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -92822,16 +94522,16 @@ paths: description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '422': *15 x-github: githubCloudOnly: false @@ -92853,10 +94553,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *430 - - *431 - - *621 - - *422 + - *447 + - *448 + - *638 + - *439 responses: '204': description: Response @@ -92885,9 +94585,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -92909,9 +94609,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92944,9 +94644,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -92956,13 +94656,13 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: *623 + default: *640 headers: Link: *41 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92990,9 +94690,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -93019,16 +94719,16 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *441 + '410': *458 '422': *15 '404': *6 x-github: @@ -93048,9 +94748,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 requestBody: required: true content: @@ -93081,13 +94781,13 @@ paths: description: Response content: application/json: - schema: *183 + schema: *200 examples: - default: *620 + default: *637 '403': *27 '404': *6 '422': *7 - '503': *163 + '503': *179 x-github: triggersNotification: true githubCloudOnly: false @@ -93105,9 +94805,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *430 - - *431 - - *621 + - *447 + - *448 + - *638 - *17 - *19 responses: @@ -93122,19 +94822,19 @@ paths: description: Timeline Event type: object anyOf: - - *625 - - *626 - - *627 - - *628 - - *629 - - *630 - - *631 - - *632 - - *633 - - *634 - - *635 - - *636 - - *637 + - *642 + - *643 + - *644 + - *645 + - *646 + - *647 + - *648 + - *649 + - *650 + - *651 + - *652 + - *653 + - *654 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -93182,12 +94882,12 @@ paths: issue_url: type: string format: uri - author_association: *184 + author_association: *201 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *185 + reactions: *202 required: - event - actor @@ -93218,7 +94918,7 @@ paths: properties: type: type: string - issue: *183 + issue: *200 required: - event - created_at @@ -93440,7 +95140,7 @@ paths: type: string body_text: type: string - author_association: *184 + author_association: *201 required: - event - id @@ -93463,7 +95163,7 @@ paths: type: string comments: type: array - items: &656 + items: &675 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -93568,7 +95268,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *184 + author_association: *201 _links: type: object properties: @@ -93663,7 +95363,7 @@ paths: enum: - line - file - reactions: *185 + reactions: *202 body_html: type: string examples: @@ -93701,7 +95401,7 @@ paths: type: string comments: type: array - items: *544 + items: *561 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93976,7 +95676,7 @@ paths: headers: Link: *41 '404': *6 - '410': *441 + '410': *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93993,8 +95693,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -94004,7 +95704,7 @@ paths: application/json: schema: type: array - items: &638 + items: &655 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -94072,8 +95772,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -94109,9 +95809,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *655 examples: - default: &639 + default: &656 value: id: 1 key: ssh-rsa AAA... @@ -94145,9 +95845,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *430 - - *431 - - &640 + - *447 + - *448 + - &657 name: key_id description: The unique identifier of the key. in: path @@ -94159,9 +95859,9 @@ paths: description: Response content: application/json: - schema: *638 + schema: *655 examples: - default: *639 + default: *656 '404': *6 x-github: githubCloudOnly: false @@ -94179,9 +95879,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *430 - - *431 - - *640 + - *447 + - *448 + - *657 responses: '204': description: Response @@ -94201,8 +95901,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -94212,9 +95912,9 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: - default: *624 + default: *641 headers: Link: *41 '404': *6 @@ -94235,8 +95935,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -94272,9 +95972,9 @@ paths: description: Response content: application/json: - schema: *182 + schema: *199 examples: - default: &641 + default: &658 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -94306,8 +96006,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *430 - - *431 + - *447 + - *448 - name: name in: path required: true @@ -94318,9 +96018,9 @@ paths: description: Response content: application/json: - schema: *182 + schema: *199 examples: - default: *641 + default: *658 '404': *6 x-github: githubCloudOnly: false @@ -94337,8 +96037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *430 - - *431 + - *447 + - *448 - name: name in: path required: true @@ -94377,7 +96077,7 @@ paths: description: Response content: application/json: - schema: *182 + schema: *199 examples: default: value: @@ -94403,8 +96103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *430 - - *431 + - *447 + - *448 - name: name in: path required: true @@ -94430,8 +96130,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -94467,8 +96167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '202': *37 '403': @@ -94496,8 +96196,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -94523,9 +96223,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *430 - - *431 - - *522 + - *447 + - *448 + - *539 responses: '200': description: Response @@ -94591,7 +96291,7 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 required: - _links - git_url @@ -94672,8 +96372,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -94738,8 +96438,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -94773,9 +96473,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *545 + schema: *562 examples: - default: *642 + default: *659 '204': description: Response when already merged '404': @@ -94800,8 +96500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *430 - - *431 + - *447 + - *448 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94842,7 +96542,7 @@ paths: application/json: schema: type: array - items: *368 + items: *386 examples: default: value: @@ -94898,8 +96598,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -94939,9 +96639,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *386 examples: - default: &643 + default: &660 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -95000,9 +96700,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *430 - - *431 - - &644 + - *447 + - *448 + - &661 name: milestone_number description: The number that identifies the milestone. in: path @@ -95014,9 +96714,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *386 examples: - default: *643 + default: *660 '404': *6 x-github: githubCloudOnly: false @@ -95033,9 +96733,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *430 - - *431 - - *644 + - *447 + - *448 + - *661 requestBody: required: false content: @@ -95073,9 +96773,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *386 examples: - default: *643 + default: *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95091,9 +96791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *430 - - *431 - - *644 + - *447 + - *448 + - *661 responses: '204': description: Response @@ -95114,9 +96814,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: - - *430 - - *431 - - *644 + - *447 + - *448 + - *661 - *17 - *19 responses: @@ -95126,9 +96826,9 @@ paths: application/json: schema: type: array - items: *182 + items: *199 examples: - default: *624 + default: *641 headers: Link: *41 x-github: @@ -95147,12 +96847,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: - - *430 - - *431 - - *645 - - *646 - - *189 - - *647 + - *447 + - *448 + - *662 + - *663 + - *206 + - *664 - *17 - *19 responses: @@ -95162,9 +96862,9 @@ paths: application/json: schema: type: array - items: *209 + items: *226 examples: - default: *648 + default: *665 headers: Link: *41 x-github: @@ -95188,8 +96888,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -95247,14 +96947,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: &649 + schema: &666 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -95398,7 +97098,7 @@ paths: - custom_404 - public examples: - default: &650 + default: &667 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -95439,8 +97139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -95495,11 +97195,11 @@ paths: description: Response content: application/json: - schema: *649 + schema: *666 examples: - default: *650 + default: *667 '422': *15 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95520,8 +97220,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -95608,7 +97308,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95629,14 +97329,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response '422': *15 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95656,8 +97356,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -95667,7 +97367,7 @@ paths: application/json: schema: type: array - items: &651 + items: &668 title: Page Build description: Page Build type: object @@ -95759,8 +97459,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *430 - - *431 + - *447 + - *448 responses: '201': description: Response @@ -95807,16 +97507,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *651 + schema: *668 examples: - default: &652 + default: &669 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95864,8 +97564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *430 - - *431 + - *447 + - *448 - name: build_id in: path required: true @@ -95876,9 +97576,9 @@ paths: description: Response content: application/json: - schema: *651 + schema: *668 examples: - default: *652 + default: *669 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95898,8 +97598,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -96007,9 +97707,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: - - *430 - - *431 - - &653 + - *447 + - *448 + - &670 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -96067,11 +97767,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *430 - - *431 - - *653 + - *447 + - *448 + - *670 responses: - '204': *129 + '204': *139 '404': *6 x-github: githubCloudOnly: false @@ -96096,8 +97796,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -96365,7 +98065,7 @@ paths: description: Empty response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -96392,8 +98092,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Private vulnerability reporting status @@ -96430,10 +98130,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: - - *430 - - *431 + - *447 + - *448 responses: - '204': *129 + '204': *139 '422': *14 x-github: githubCloudOnly: false @@ -96452,10 +98152,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: - - *430 - - *431 + - *447 + - *448 responses: - '204': *129 + '204': *139 '422': *14 x-github: githubCloudOnly: false @@ -96476,8 +98176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects parameters: - - *430 - - *431 + - *447 + - *448 - name: state description: Indicates the state of the projects to return. in: query @@ -96498,7 +98198,7 @@ paths: application/json: schema: type: array - items: *362 + items: *380 examples: default: value: @@ -96538,7 +98238,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *441 + '410': *458 '422': *7 x-github: githubCloudOnly: false @@ -96561,8 +98261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -96588,13 +98288,13 @@ paths: description: Response content: application/json: - schema: *362 + schema: *380 examples: - default: *440 + default: *457 '401': *23 '403': *27 '404': *6 - '410': *441 + '410': *458 '422': *7 x-github: githubCloudOnly: false @@ -96617,8 +98317,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -96626,16 +98326,9 @@ paths: application/json: schema: type: array - items: *376 + items: *140 examples: - default: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *671 '403': *27 '404': *6 x-github: @@ -96657,8 +98350,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -96670,19 +98363,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *376 + items: *140 required: - properties examples: - default: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat + default: *672 responses: '204': description: No Content when custom property values are successfully created @@ -96720,8 +98405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *430 - - *431 + - *447 + - *448 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -96781,9 +98466,9 @@ paths: application/json: schema: type: array - items: *549 + items: *566 examples: - default: *654 + default: *673 headers: Link: *41 '304': *35 @@ -96815,8 +98500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -96883,7 +98568,7 @@ paths: description: Response content: application/json: - schema: &658 + schema: &677 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -97012,7 +98697,7 @@ paths: milestone: anyOf: - type: 'null' - - *368 + - *386 active_lock_reason: type: - string @@ -97067,7 +98752,7 @@ paths: type: - array - 'null' - items: *344 + items: *362 head: type: object properties: @@ -97075,7 +98760,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *72 sha: type: string user: *4 @@ -97092,7 +98777,7 @@ paths: type: string ref: type: string - repo: *67 + repo: *72 sha: type: string user: *4 @@ -97105,14 +98790,14 @@ paths: _links: type: object properties: - comments: *369 - commits: *369 - statuses: *369 - html: *369 - issue: *369 - review_comments: *369 - review_comment: *369 - self: *369 + comments: *387 + commits: *387 + statuses: *387 + html: *387 + issue: *387 + review_comments: *387 + review_comment: *387 + self: *387 required: - comments - commits @@ -97122,8 +98807,8 @@ paths: - review_comments - review_comment - self - author_association: *184 - auto_merge: *655 + author_association: *201 + auto_merge: *674 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -97225,7 +98910,7 @@ paths: - merged_by - review_comments examples: - default: &659 + default: &678 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -97752,8 +99437,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *430 - - *431 + - *447 + - *448 - name: sort in: query required: false @@ -97772,7 +99457,7 @@ paths: enum: - asc - desc - - *189 + - *206 - *17 - *19 responses: @@ -97782,9 +99467,9 @@ paths: application/json: schema: type: array - items: *656 + items: *675 examples: - default: &661 + default: &680 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97861,17 +99546,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: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '200': description: Response content: application/json: - schema: *656 + schema: *675 examples: - default: &657 + default: &676 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97946,9 +99631,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: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -97970,9 +99655,9 @@ paths: description: Response content: application/json: - schema: *656 + schema: *675 examples: - default: *657 + default: *676 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97988,9 +99673,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: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 responses: '204': description: Response @@ -98011,9 +99696,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: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 - 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. @@ -98039,9 +99724,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 '404': *6 @@ -98062,9 +99747,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: - - *430 - - *431 - - *198 + - *447 + - *448 + - *215 requestBody: required: true content: @@ -98096,16 +99781,16 @@ paths: description: Reaction exists content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Reaction created content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '422': *15 x-github: githubCloudOnly: false @@ -98127,10 +99812,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *430 - - *431 - - *198 - - *422 + - *447 + - *448 + - *215 + - *439 responses: '204': description: Response @@ -98173,9 +99858,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *430 - - *431 - - &660 + - *447 + - *448 + - &679 name: pull_number description: The number that identifies the pull request. in: path @@ -98188,9 +99873,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *658 + schema: *677 examples: - default: *659 + default: *678 '304': *35 '404': *6 '406': @@ -98199,7 +99884,7 @@ paths: application/json: schema: *3 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98225,9 +99910,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: false content: @@ -98269,9 +99954,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *677 examples: - default: *659 + default: *678 '422': *15 '403': *27 x-github: @@ -98293,9 +99978,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: true content: @@ -98356,21 +100041,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '401': *23 '403': *27 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98396,10 +100081,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: - - *430 - - *431 - - *660 - - *206 + - *447 + - *448 + - *679 + - *223 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -98409,7 +100094,7 @@ paths: enum: - asc - desc - - *189 + - *206 - *17 - *19 responses: @@ -98419,9 +100104,9 @@ paths: application/json: schema: type: array - items: *656 + items: *675 examples: - default: *661 + default: *680 headers: Link: *41 x-github: @@ -98454,9 +100139,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: true content: @@ -98562,7 +100247,7 @@ paths: description: Response content: application/json: - schema: *656 + schema: *675 examples: example-for-a-multi-line-comment: value: @@ -98650,10 +100335,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: - - *430 - - *431 - - *660 - - *198 + - *447 + - *448 + - *679 + - *215 requestBody: required: true content: @@ -98675,7 +100360,7 @@ paths: description: Response content: application/json: - schema: *656 + schema: *675 examples: default: value: @@ -98761,9 +100446,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 - *17 - *19 responses: @@ -98773,9 +100458,9 @@ paths: application/json: schema: type: array - items: *545 + items: *562 examples: - default: *662 + default: *681 headers: Link: *41 x-github: @@ -98805,9 +100490,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 - *17 - *19 responses: @@ -98817,7 +100502,7 @@ paths: application/json: schema: type: array - items: *556 + items: *573 examples: default: value: @@ -98836,7 +100521,7 @@ paths: Link: *41 '422': *15 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98855,9 +100540,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 responses: '204': description: Response if pull request has been merged @@ -98880,9 +100565,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: false content: @@ -98994,9 +100679,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 responses: '200': description: Response @@ -99012,7 +100697,7 @@ paths: items: *4 teams: type: array - items: *273 + items: *293 required: - users - teams @@ -99071,9 +100756,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: false content: @@ -99110,7 +100795,7 @@ paths: description: Response content: application/json: - schema: *549 + schema: *566 examples: default: value: @@ -99646,9 +101331,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: true content: @@ -99682,7 +101367,7 @@ paths: description: Response content: application/json: - schema: *549 + schema: *566 examples: default: value: @@ -100187,9 +101872,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 - *17 - *19 responses: @@ -100199,7 +101884,7 @@ paths: application/json: schema: type: array - items: &663 + items: &682 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -100273,7 +101958,7 @@ paths: type: string body_text: type: string - author_association: *184 + author_association: *201 required: - id - node_id @@ -100355,9 +102040,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: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: false content: @@ -100447,9 +102132,9 @@ paths: description: Response content: application/json: - schema: *663 + schema: *682 examples: - default: &665 + default: &684 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -100512,10 +102197,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: - - *430 - - *431 - - *660 - - &664 + - *447 + - *448 + - *679 + - &683 name: review_id description: The unique identifier of the review. in: path @@ -100527,9 +102212,9 @@ paths: description: Response content: application/json: - schema: *663 + schema: *682 examples: - default: &666 + default: &685 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -100588,10 +102273,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: - - *430 - - *431 - - *660 - - *664 + - *447 + - *448 + - *679 + - *683 requestBody: required: true content: @@ -100614,7 +102299,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *682 examples: default: value: @@ -100676,18 +102361,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: - - *430 - - *431 - - *660 - - *664 + - *447 + - *448 + - *679 + - *683 responses: '200': description: Response content: application/json: - schema: *663 + schema: *682 examples: - default: *665 + default: *684 '422': *7 '404': *6 x-github: @@ -100714,10 +102399,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: - - *430 - - *431 - - *660 - - *664 + - *447 + - *448 + - *679 + - *683 - *17 - *19 responses: @@ -100811,13 +102496,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *184 + author_association: *201 _links: type: object properties: - self: *369 - html: *369 - pull_request: *369 + self: *387 + html: *387 + pull_request: *387 required: - self - html @@ -100826,7 +102511,7 @@ paths: type: string body_html: type: string - reactions: *185 + reactions: *202 side: description: The side of the first line of the range for a multi-line comment. @@ -100975,10 +102660,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: - - *430 - - *431 - - *660 - - *664 + - *447 + - *448 + - *679 + - *683 requestBody: required: true content: @@ -101007,7 +102692,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *682 examples: default: value: @@ -101070,10 +102755,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: - - *430 - - *431 - - *660 - - *664 + - *447 + - *448 + - *679 + - *683 requestBody: required: true content: @@ -101108,9 +102793,9 @@ paths: description: Response content: application/json: - schema: *663 + schema: *682 examples: - default: *666 + default: *685 '404': *6 '422': *7 '403': *27 @@ -101132,9 +102817,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *430 - - *431 - - *660 + - *447 + - *448 + - *679 requestBody: required: false content: @@ -101198,8 +102883,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *430 - - *431 + - *447 + - *448 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -101212,9 +102897,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *686 examples: - default: &668 + default: &687 value: type: file encoding: base64 @@ -101256,8 +102941,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: - - *430 - - *431 + - *447 + - *448 - name: dir description: The alternate path to look for a README file in: path @@ -101277,9 +102962,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *686 examples: - default: *668 + default: *687 '404': *6 '422': *15 x-github: @@ -101301,8 +102986,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -101312,7 +102997,7 @@ paths: application/json: schema: type: array - items: *669 + items: *688 examples: default: value: @@ -101406,8 +103091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -101483,9 +103168,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *688 examples: - default: &673 + default: &692 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -101590,9 +103275,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *430 - - *431 - - &671 + - *447 + - *448 + - &690 name: asset_id description: The unique identifier of the asset. in: path @@ -101604,9 +103289,9 @@ paths: description: Response content: application/json: - schema: *670 + schema: *689 examples: - default: &672 + default: &691 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 @@ -101641,7 +103326,7 @@ paths: type: User site_admin: false '404': *6 - '302': *558 + '302': *575 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101657,9 +103342,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *430 - - *431 - - *671 + - *447 + - *448 + - *690 requestBody: required: false content: @@ -101688,9 +103373,9 @@ paths: description: Response content: application/json: - schema: *670 + schema: *689 examples: - default: *672 + default: *691 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101706,9 +103391,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *430 - - *431 - - *671 + - *447 + - *448 + - *690 responses: '204': description: Response @@ -101732,8 +103417,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -101819,16 +103504,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response content: application/json: - schema: *669 + schema: *688 examples: - default: *673 + default: *692 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101845,8 +103530,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *430 - - *431 + - *447 + - *448 - name: tag description: tag parameter in: path @@ -101859,9 +103544,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *688 examples: - default: *673 + default: *692 '404': *6 x-github: githubCloudOnly: false @@ -101883,9 +103568,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *430 - - *431 - - &674 + - *447 + - *448 + - &693 name: release_id description: The unique identifier of the release. in: path @@ -101899,9 +103584,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: *669 + schema: *688 examples: - default: *673 + default: *692 '401': description: Unauthorized x-github: @@ -101919,9 +103604,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 requestBody: required: false content: @@ -101985,9 +103670,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *688 examples: - default: *673 + default: *692 '404': description: Not Found if the discussion category name is invalid content: @@ -102008,9 +103693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 responses: '204': description: Response @@ -102030,9 +103715,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 - *17 - *19 responses: @@ -102042,7 +103727,7 @@ paths: application/json: schema: type: array - items: *670 + items: *689 examples: default: value: @@ -102124,9 +103809,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: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 - name: name in: query required: true @@ -102152,7 +103837,7 @@ paths: description: Response for successful upload content: application/json: - schema: *670 + schema: *689 examples: response-for-successful-upload: value: @@ -102207,9 +103892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 - 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. @@ -102233,9 +103918,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 '404': *6 @@ -102256,9 +103941,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *430 - - *431 - - *674 + - *447 + - *448 + - *693 requestBody: required: true content: @@ -102288,16 +103973,16 @@ paths: description: Reaction exists content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '201': description: Reaction created content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 '422': *15 x-github: githubCloudOnly: false @@ -102319,10 +104004,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *430 - - *431 - - *674 - - *422 + - *447 + - *448 + - *693 + - *439 responses: '204': description: Response @@ -102346,9 +104031,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *430 - - *431 - - *489 + - *447 + - *448 + - *506 - *17 - *19 responses: @@ -102364,8 +104049,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *138 - - &675 + - *154 + - &694 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -102385,68 +104070,68 @@ paths: type: integer description: The ID of the ruleset that includes this rule. - allOf: - - *139 - - *675 + - *155 + - *694 - allOf: - - *140 - - *675 + - *156 + - *694 - allOf: - - *141 - - *675 + - *157 + - *694 - allOf: - - *676 - - *675 + - *695 + - *694 - allOf: - - *142 - - *675 + - *158 + - *694 - allOf: - - *143 - - *675 + - *159 + - *694 - allOf: - - *144 - - *675 + - *160 + - *694 - allOf: - - *145 - - *675 + - *161 + - *694 - allOf: - - *146 - - *675 + - *162 + - *694 - allOf: - - *147 - - *675 + - *163 + - *694 - allOf: - - *148 - - *675 + - *164 + - *694 - allOf: - - *149 - - *675 + - *165 + - *694 - allOf: - - *150 - - *675 + - *166 + - *694 - allOf: - - *151 - - *675 + - *167 + - *694 - allOf: - - *152 - - *675 + - *168 + - *694 - allOf: - - *153 - - *675 + - *169 + - *694 - allOf: - - *154 - - *675 + - *170 + - *694 - allOf: - - *155 - - *675 + - *171 + - *694 - allOf: - - *156 - - *675 + - *172 + - *694 - allOf: - - *157 - - *675 + - *173 + - *694 - allOf: - - *677 - - *675 + - *696 + - *694 examples: default: value: @@ -102485,8 +104170,8 @@ paths: category: repos subcategory: rules parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 - name: includes_parents @@ -102497,7 +104182,7 @@ paths: schema: type: boolean default: true - - *678 + - *697 responses: '200': description: Response @@ -102505,7 +104190,7 @@ paths: application/json: schema: type: array - items: *158 + items: *174 examples: default: value: @@ -102552,8 +104237,8 @@ paths: category: repos subcategory: rules parameters: - - *430 - - *431 + - *447 + - *448 requestBody: description: Request body required: true @@ -102573,16 +104258,16 @@ paths: - tag - push default: branch - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 - conditions: *132 + items: *153 + conditions: *146 rules: type: array description: An array of rules within the ruleset. - items: *679 + items: *698 required: - name - enforcement @@ -102613,9 +104298,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: &688 + default: &707 value: id: 42 name: super cool ruleset @@ -102662,12 +104347,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *430 - - *431 - - *680 - - *94 - - *681 - - *682 + - *447 + - *448 + - *699 + - *99 + - *700 + - *701 - *17 - *19 responses: @@ -102675,9 +104360,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *702 examples: - default: *684 + default: *703 '404': *6 '500': *38 x-github: @@ -102698,17 +104383,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *430 - - *431 - - *685 + - *447 + - *448 + - *704 responses: '200': description: Response content: application/json: - schema: *686 + schema: *705 examples: - default: *687 + default: *706 '404': *6 '500': *38 x-github: @@ -102736,8 +104421,8 @@ paths: category: repos subcategory: rules parameters: - - *430 - - *431 + - *447 + - *448 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102757,9 +104442,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *688 + default: *707 '404': *6 '500': *38 put: @@ -102777,8 +104462,8 @@ paths: category: repos subcategory: rules parameters: - - *430 - - *431 + - *447 + - *448 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102803,16 +104488,16 @@ paths: - branch - tag - push - enforcement: *136 + enforcement: *152 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *137 - conditions: *132 + items: *153 + conditions: *146 rules: description: An array of rules within the ruleset. type: array - items: *679 + items: *698 examples: default: value: @@ -102840,9 +104525,9 @@ paths: description: Response content: application/json: - schema: *158 + schema: *174 examples: - default: *688 + default: *707 '404': *6 '500': *38 delete: @@ -102860,8 +104545,8 @@ paths: category: repos subcategory: rules parameters: - - *430 - - *431 + - *447 + - *448 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102884,8 +104569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 - name: ruleset_id @@ -102901,9 +104586,9 @@ paths: application/json: schema: type: array - items: *162 + items: *178 examples: - default: *383 + default: *400 '404': *6 '500': *38 x-github: @@ -102922,8 +104607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *430 - - *431 + - *447 + - *448 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102941,7 +104626,7 @@ paths: description: Response content: application/json: - schema: *384 + schema: *401 examples: default: value: @@ -102996,21 +104681,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: - - *430 - - *431 - - *385 - - *386 - - *387 - - *388 - - *99 + - *447 + - *448 + - *402 + - *403 + - *404 + - *405 + - *104 - *19 - *17 - - *689 - - *690 - - *389 - - *390 - - *391 - - *392 + - *708 + - *709 + - *406 + - *407 + - *408 + - *409 responses: '200': description: Response @@ -103018,24 +104703,24 @@ paths: application/json: schema: type: array - items: &694 + items: &713 type: object properties: - number: *109 - created_at: *116 + number: *119 + created_at: *126 updated_at: anyOf: - type: 'null' - - *117 - url: *114 - html_url: *115 + - *127 + url: *124 + html_url: *125 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *691 - resolution: *692 + state: *710 + resolution: *711 resolved_at: type: - string @@ -103129,7 +104814,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *693 + - *712 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -103252,7 +104937,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103274,16 +104959,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: - - *430 - - *431 - - *516 - - *392 + - *447 + - *448 + - *533 + - *409 responses: '200': description: Response content: application/json: - schema: *694 + schema: *713 examples: default: value: @@ -103314,7 +104999,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103335,9 +105020,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 requestBody: required: true content: @@ -103345,8 +105030,8 @@ paths: schema: type: object properties: - state: *691 - resolution: *692 + state: *710 + resolution: *711 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -103365,7 +105050,7 @@ paths: description: Response content: application/json: - schema: *694 + schema: *713 examples: default: value: @@ -103418,7 +105103,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -103440,9 +105125,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: - - *430 - - *431 - - *516 + - *447 + - *448 + - *533 - *19 - *17 responses: @@ -103453,7 +105138,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &869 + items: &887 type: object properties: type: @@ -103480,19 +105165,19 @@ paths: - commit details: oneOf: - - *695 - - *696 - - *697 - - *698 - - *699 - - *700 - - *701 - - *702 - - *703 - - *704 - - *705 - - *706 - - *707 + - *714 + - *715 + - *716 + - *717 + - *718 + - *719 + - *720 + - *721 + - *722 + - *723 + - *724 + - *725 + - *726 examples: default: value: @@ -103556,7 +105241,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103578,8 +105263,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -103587,14 +105272,14 @@ paths: schema: type: object properties: - reason: &709 + reason: &728 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *708 + placeholder_id: *727 required: - reason - placeholder_id @@ -103611,7 +105296,7 @@ paths: schema: type: object properties: - reason: *709 + reason: *728 expire_at: type: - string @@ -103635,7 +105320,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *163 + '503': *179 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -103647,6 +105332,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 @@ -103655,13 +105343,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: - - *430 - - *431 + - *447 + - *448 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *163 + '503': *179 '200': description: Response content: @@ -103671,7 +105359,7 @@ paths: properties: incremental_scans: type: array - items: &710 + items: &729 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103699,15 +105387,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *710 + items: *729 backfill_scans: type: array - items: *710 + items: *729 custom_pattern_backfill_scans: type: array items: allOf: - - *710 + - *729 - type: object properties: pattern_name: @@ -103777,9 +105465,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *430 - - *431 - - *99 + - *447 + - *448 + - *104 - name: sort description: The property to sort the results by. in: query @@ -103791,8 +105479,8 @@ paths: - updated - published default: created - - *97 - - *98 + - *102 + - *103 - 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)." @@ -103822,9 +105510,9 @@ paths: application/json: schema: type: array - items: *711 + items: *730 examples: - default: *712 + default: *731 '400': *14 '404': *6 x-github: @@ -103847,8 +105535,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -103928,7 +105616,7 @@ paths: login: type: string description: The username of the user credited. - type: *397 + type: *414 required: - login - type @@ -104018,9 +105706,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *730 examples: - default: &714 + default: &733 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -104253,8 +105941,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -104367,7 +106055,7 @@ paths: description: Response content: application/json: - schema: *711 + schema: *730 examples: default: value: @@ -104514,17 +106202,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: - - *430 - - *431 - - *713 + - *447 + - *448 + - *732 responses: '200': description: Response content: application/json: - schema: *711 + schema: *730 examples: - default: *714 + default: *733 '403': *27 '404': *6 x-github: @@ -104548,9 +106236,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: - - *430 - - *431 - - *713 + - *447 + - *448 + - *732 requestBody: required: true content: @@ -104630,7 +106318,7 @@ paths: login: type: string description: The username of the user credited. - type: *397 + type: *414 required: - login - type @@ -104721,17 +106409,17 @@ paths: description: Response content: application/json: - schema: *711 + schema: *730 examples: - default: *714 - add_credit: *714 + default: *733 + add_credit: *733 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *223 + schema: *241 examples: invalid_state_transition: value: @@ -104762,9 +106450,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: - - *430 - - *431 - - *713 + - *447 + - *448 + - *732 responses: '202': *37 '400': *14 @@ -104791,17 +106479,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: - - *430 - - *431 - - *713 + - *447 + - *448 + - *732 responses: '202': description: Response content: application/json: - schema: *443 + schema: *460 examples: - default: *445 + default: *462 '400': *14 '422': *15 '403': *27 @@ -104827,8 +106515,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -104924,8 +106612,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104934,7 +106622,7 @@ paths: application/json: schema: type: array - items: &715 + items: &734 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104947,7 +106635,7 @@ paths: - 1124 - -435 '202': *37 - '204': *129 + '204': *139 '422': description: Repository contains more than 10,000 commits x-github: @@ -104967,8 +106655,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -105019,7 +106707,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *129 + '204': *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105046,8 +106734,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -105119,7 +106807,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *129 + '204': *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105141,8 +106829,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -105296,8 +106984,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -105307,7 +106995,7 @@ paths: application/json: schema: type: array - items: *715 + items: *734 examples: default: value: @@ -105320,7 +107008,7 @@ paths: - - 0 - 2 - 21 - '204': *129 + '204': *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105340,8 +107028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *430 - - *431 + - *447 + - *448 - name: sha in: path required: true @@ -105397,7 +107085,7 @@ paths: description: Response content: application/json: - schema: *716 + schema: *735 examples: default: value: @@ -105451,8 +107139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -105464,7 +107152,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -105484,14 +107172,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &717 + schema: &736 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -105564,8 +107252,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: false content: @@ -105591,7 +107279,7 @@ paths: description: Response content: application/json: - schema: *717 + schema: *736 examples: default: value: @@ -105618,8 +107306,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -105639,8 +107327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -105722,8 +107410,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: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -105731,7 +107419,7 @@ paths: application/json: schema: type: array - items: &718 + items: &737 title: Tag protection description: Tag protection type: object @@ -105788,8 +107476,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: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -105812,7 +107500,7 @@ paths: description: Response content: application/json: - schema: *718 + schema: *737 examples: default: value: @@ -105843,8 +107531,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: - - *430 - - *431 + - *447 + - *448 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -105881,8 +107569,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *430 - - *431 + - *447 + - *448 - name: ref in: path required: true @@ -105918,8 +107606,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *430 - - *431 + - *447 + - *448 - *17 - *19 responses: @@ -105929,9 +107617,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - default: *345 + default: *363 headers: Link: *41 '404': *6 @@ -105951,8 +107639,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *430 - - *431 + - *447 + - *448 - *19 - *17 responses: @@ -105960,7 +107648,7 @@ paths: description: Response content: application/json: - schema: &719 + schema: &738 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105972,7 +107660,7 @@ paths: required: - names examples: - default: &720 + default: &739 value: names: - octocat @@ -105995,8 +107683,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -106027,9 +107715,9 @@ paths: description: Response content: application/json: - schema: *719 + schema: *738 examples: - default: *720 + default: *739 '404': *6 '422': *7 x-github: @@ -106050,9 +107738,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *430 - - *431 - - &721 + - *447 + - *448 + - &740 name: per description: The time frame to display results for. in: query @@ -106083,7 +107771,7 @@ paths: - 128 clones: type: array - items: &722 + items: &741 title: Traffic type: object properties: @@ -106170,8 +107858,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -106265,8 +107953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *430 - - *431 + - *447 + - *448 responses: '200': description: Response @@ -106329,9 +108017,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *430 - - *431 - - *721 + - *447 + - *448 + - *740 responses: '200': description: Response @@ -106352,7 +108040,7 @@ paths: - 3782 views: type: array - items: *722 + items: *741 required: - uniques - count @@ -106429,8 +108117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *430 - - *431 + - *447 + - *448 requestBody: required: true content: @@ -106466,7 +108154,7 @@ paths: description: Response content: application/json: - schema: *246 + schema: *266 examples: default: value: @@ -106704,8 +108392,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -106728,8 +108416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -106751,8 +108439,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -106778,8 +108466,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *430 - - *431 + - *447 + - *448 - name: ref in: path required: true @@ -106871,9 +108559,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - default: *445 + default: *462 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106914,7 +108602,7 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: default: value: @@ -107024,7 +108712,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &730 + - &749 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -107034,7 +108722,7 @@ paths: type: string examples: - members - - &735 + - &754 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -107046,7 +108734,7 @@ paths: format: int32 examples: - 1 - - &736 + - &755 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -107090,7 +108778,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &725 + items: &744 allOf: - type: object required: @@ -107172,7 +108860,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: &737 + meta: &756 type: object description: The metadata associated with the creation/updates to the user. @@ -107237,30 +108925,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &726 + '400': &745 description: Bad request content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 - '401': *724 - '403': &727 + schema: *742 + '401': *743 + '403': &746 description: Permission denied - '429': &728 + '429': &747 description: Too many requests content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 - '500': &729 + schema: *742 + '500': &748 description: Internal server error content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 + schema: *742 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107284,7 +108972,7 @@ paths: required: true content: application/json: - schema: &733 + schema: &752 type: object required: - schemas @@ -107348,9 +109036,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *725 + schema: *744 examples: - group: &731 + group: &750 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -107369,13 +109057,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': *726 - '401': *724 - '403': *727 - '409': &734 + '400': *745 + '401': *743 + '403': *746 + '409': &753 description: Duplicate record detected - '429': *728 - '500': *729 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107392,7 +109080,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: - - &732 + - &751 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -107401,22 +109089,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *730 + - *749 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *725 + schema: *744 examples: - default: *731 - '400': *726 - '401': *724 - '403': *727 + default: *750 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '429': *728 - '500': *729 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107435,13 +109123,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: - - *732 + - *751 - *39 requestBody: required: true content: application/json: - schema: *733 + schema: *752 examples: group: summary: Group @@ -107467,17 +109155,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *725 + schema: *744 examples: - group: *731 - groupWithMembers: *731 - '400': *726 - '401': *724 - '403': *727 + group: *750 + groupWithMembers: *750 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '409': *734 - '429': *728 - '500': *729 + '409': *753 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107501,13 +109189,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: - - *732 + - *751 - *39 requestBody: required: true content: application/json: - schema: &744 + schema: &763 type: object required: - Operations @@ -107567,17 +109255,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *725 + schema: *744 examples: - updateGroup: *731 - addMembers: *731 - '400': *726 - '401': *724 - '403': *727 + updateGroup: *750 + addMembers: *750 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '409': *734 - '429': *728 - '500': *729 + '409': *753 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107593,17 +109281,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: - - *732 + - *751 - *39 responses: '204': description: Group was deleted, no content - '400': *726 - '401': *724 - '403': *727 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '429': *728 - '500': *729 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107637,8 +109325,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *735 - - *736 + - *754 + - *755 - *39 responses: '200': @@ -107672,7 +109360,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &739 + items: &758 allOf: - type: object required: @@ -107764,7 +109452,7 @@ paths: address. examples: - true - roles: &738 + roles: &757 type: array description: The roles assigned to the user. items: @@ -107823,7 +109511,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *737 + meta: *756 startIndex: type: integer description: A starting index for the returned page @@ -107862,11 +109550,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *726 - '401': *724 - '403': *727 - '429': *728 - '500': *729 + '400': *745 + '401': *743 + '403': *746 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107890,7 +109578,7 @@ paths: required: true content: application/json: - schema: &742 + schema: &761 type: object required: - schemas @@ -107983,9 +109671,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *738 + roles: *757 examples: - user: &743 + user: &762 summary: User value: schemas: @@ -108032,9 +109720,9 @@ paths: description: User has been created content: application/scim+json: - schema: *739 + schema: *758 examples: - user: &740 + user: &759 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -108060,13 +109748,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: *740 - '400': *726 - '401': *724 - '403': *727 - '409': *734 - '429': *728 - '500': *729 + enterpriseOwner: *759 + '400': *745 + '401': *743 + '403': *746 + '409': *753 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108083,7 +109771,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: - - &741 + - &760 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -108096,15 +109784,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *739 + schema: *758 examples: - default: *740 - '400': *726 - '401': *724 - '403': *727 + default: *759 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '429': *728 - '500': *729 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108126,30 +109814,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: - - *741 + - *760 - *39 requestBody: required: true content: application/json: - schema: *742 + schema: *761 examples: - user: *743 + user: *762 responses: '200': description: User was updated content: application/scim+json: - schema: *739 + schema: *758 examples: - user: *740 - '400': *726 - '401': *724 - '403': *727 + user: *759 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '409': *734 - '429': *728 - '500': *729 + '409': *753 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108184,13 +109872,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: - - *741 + - *760 - *39 requestBody: required: true content: application/json: - schema: *744 + schema: *763 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -108230,18 +109918,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *739 + schema: *758 examples: - userMultiValuedProperties: *740 - userSingleValuedProperties: *740 - disableUser: *740 - '400': *726 - '401': *724 - '403': *727 + userMultiValuedProperties: *759 + userSingleValuedProperties: *759 + disableUser: *759 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '409': *734 - '429': *728 - '500': *729 + '409': *753 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108261,17 +109949,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: - - *741 + - *760 - *39 responses: '204': description: User was deleted, no content - '400': *726 - '401': *724 - '403': *727 + '400': *745 + '401': *743 + '403': *746 '404': *6 - '429': *728 - '500': *729 + '429': *747 + '500': *748 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108304,7 +109992,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *76 + - *81 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -108362,7 +110050,7 @@ paths: - 1 Resources: type: array - items: &745 + items: &764 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -108609,22 +110297,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': *35 - '404': &746 + '404': &765 description: Resource not found content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 - '403': &747 + schema: *742 + '403': &766 description: Forbidden content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 - '400': *726 - '429': *728 + schema: *742 + '400': *745 + '429': *747 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -108644,15 +110332,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *76 + - *81 responses: '201': description: Response content: application/scim+json: - schema: *745 + schema: *764 examples: - default: &748 + default: &767 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -108675,17 +110363,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': *35 - '404': *746 - '403': *747 - '500': *729 + '404': *765 + '403': *766 + '500': *748 '409': description: Conflict content: application/json: - schema: *723 + schema: *742 application/scim+json: - schema: *723 - '400': *726 + schema: *742 + '400': *745 requestBody: required: true content: @@ -108784,18 +110472,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: - - *76 - - *741 + - *81 + - *760 responses: '200': description: Response content: application/scim+json: - schema: *745 + schema: *764 examples: - default: *748 - '404': *746 - '403': *747 + default: *767 + '404': *765 + '403': *766 '304': *35 x-github: githubCloudOnly: true @@ -108818,19 +110506,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *76 - - *741 + - *81 + - *760 responses: '200': description: Response content: application/scim+json: - schema: *745 + schema: *764 examples: - default: *748 + default: *767 '304': *35 - '404': *746 - '403': *747 + '404': *765 + '403': *766 requestBody: required: true content: @@ -108944,20 +110632,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: - - *76 - - *741 + - *81 + - *760 responses: '200': description: Response content: application/scim+json: - schema: *745 + schema: *764 examples: - default: *748 + default: *767 '304': *35 - '404': *746 - '403': *747 - '400': *726 + '404': *765 + '403': *766 + '400': *745 '429': description: Response content: @@ -109052,13 +110740,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: - - *76 - - *741 + - *81 + - *760 responses: '204': description: Response - '404': *746 - '403': *747 + '404': *765 + '403': *766 '304': *35 x-github: githubCloudOnly: true @@ -109173,7 +110861,7 @@ paths: html_url: type: string format: uri - repository: *246 + repository: *266 score: type: number file_size: @@ -109192,7 +110880,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &749 + text_matches: &768 title: Search Result Text Matches type: array items: @@ -109307,7 +110995,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *163 + '503': *179 '422': *15 '403': *27 x-github: @@ -109356,7 +111044,7 @@ paths: enum: - author-date - committer-date - - &750 + - &769 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 @@ -109425,7 +111113,7 @@ paths: committer: anyOf: - type: 'null' - - *487 + - *504 comment_count: type: integer message: @@ -109444,7 +111132,7 @@ paths: url: type: string format: uri - verification: *603 + verification: *620 required: - author - committer @@ -109459,7 +111147,7 @@ paths: committer: anyOf: - type: 'null' - - *487 + - *504 parents: type: array items: @@ -109471,12 +111159,12 @@ paths: type: string sha: type: string - repository: *246 + repository: *266 score: type: number node_id: type: string - text_matches: *749 + text_matches: *768 required: - sha - node_id @@ -109669,7 +111357,7 @@ paths: - interactions - created - updated - - *750 + - *769 - *17 - *19 - name: advanced_search @@ -109766,11 +111454,11 @@ paths: type: - string - 'null' - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: type: string state_reason: @@ -109784,7 +111472,7 @@ paths: milestone: anyOf: - type: 'null' - - *368 + - *386 comments: type: integer created_at: @@ -109798,7 +111486,7 @@ paths: - string - 'null' format: date-time - text_matches: *749 + text_matches: *768 pull_request: type: object properties: @@ -109836,10 +111524,10 @@ paths: type: string score: type: number - author_association: *184 + author_association: *201 draft: type: boolean - repository: *67 + repository: *72 body_html: type: string body_text: @@ -109847,12 +111535,12 @@ paths: timeline_url: type: string format: uri - type: *331 + type: *349 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *185 + reactions: *202 required: - assignee - closed_at @@ -109968,7 +111656,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *163 + '503': *179 '422': *15 '304': *35 '403': *27 @@ -110021,7 +111709,7 @@ paths: enum: - created - updated - - *750 + - *769 - *17 - *19 responses: @@ -110066,7 +111754,7 @@ paths: - 'null' score: type: number - text_matches: *749 + text_matches: *768 required: - id - node_id @@ -110152,7 +111840,7 @@ paths: - forks - help-wanted-issues - updated - - *750 + - *769 - *17 - *19 responses: @@ -110371,7 +112059,7 @@ paths: license: anyOf: - type: 'null' - - *186 + - *203 permissions: type: object properties: @@ -110389,7 +112077,7 @@ paths: - admin - pull - push - text_matches: *749 + text_matches: *768 temp_clone_token: type: string allow_merge_commit: @@ -110592,7 +112280,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *163 + '503': *179 '422': *15 '304': *35 x-github: @@ -110698,7 +112386,7 @@ paths: - string - 'null' format: uri - text_matches: *749 + text_matches: *768 related: type: - array @@ -110893,7 +112581,7 @@ paths: - followers - repositories - joined - - *750 + - *769 - *17 - *19 responses: @@ -111003,7 +112691,7 @@ paths: type: - boolean - 'null' - text_matches: *749 + text_matches: *768 blog: type: - string @@ -111065,7 +112753,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *163 + '503': *179 '422': *15 x-github: githubCloudOnly: false @@ -111085,7 +112773,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &754 + - &773 name: team_id description: The unique identifier of the team. in: path @@ -111097,9 +112785,9 @@ paths: description: Response content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '404': *6 x-github: githubCloudOnly: false @@ -111126,7 +112814,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *754 + - *773 requestBody: required: true content: @@ -111190,16 +112878,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '201': description: Response content: application/json: - schema: *411 + schema: *428 examples: - default: *412 + default: *429 '404': *6 '422': *15 '403': *27 @@ -111227,7 +112915,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *754 + - *773 responses: '204': description: Response @@ -111258,8 +112946,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *754 - - *99 + - *773 + - *104 - *17 - *19 responses: @@ -111269,9 +112957,9 @@ paths: application/json: schema: type: array - items: *413 + items: *430 examples: - default: *755 + default: *774 headers: Link: *41 x-github: @@ -111300,7 +112988,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *754 + - *773 requestBody: required: true content: @@ -111334,9 +113022,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: *414 + default: *431 x-github: triggersNotification: true githubCloudOnly: false @@ -111363,16 +113051,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *754 - - *415 + - *773 + - *432 responses: '200': description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: *414 + default: *431 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111397,8 +113085,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *754 - - *415 + - *773 + - *432 requestBody: required: false content: @@ -111421,9 +113109,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *430 examples: - default: *756 + default: *775 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111448,8 +113136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *754 - - *415 + - *773 + - *432 responses: '204': description: Response @@ -111478,9 +113166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *754 - - *415 - - *99 + - *773 + - *432 + - *104 - *17 - *19 responses: @@ -111490,9 +113178,9 @@ paths: application/json: schema: type: array - items: *416 + items: *433 examples: - default: *757 + default: *776 headers: Link: *41 x-github: @@ -111521,8 +113209,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *754 - - *415 + - *773 + - *432 requestBody: required: true content: @@ -111544,9 +113232,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: *417 + default: *434 x-github: triggersNotification: true githubCloudOnly: false @@ -111573,17 +113261,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *754 - - *415 - - *418 + - *773 + - *432 + - *435 responses: '200': description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: *417 + default: *434 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111608,9 +113296,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *754 - - *415 - - *418 + - *773 + - *432 + - *435 requestBody: required: true content: @@ -111632,9 +113320,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *433 examples: - default: *758 + default: *777 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111659,9 +113347,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *754 - - *415 - - *418 + - *773 + - *432 + - *435 responses: '204': description: Response @@ -111690,9 +113378,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: - - *754 - - *415 - - *418 + - *773 + - *432 + - *435 - 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. @@ -111718,9 +113406,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 x-github: @@ -111749,9 +113437,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: - - *754 - - *415 - - *418 + - *773 + - *432 + - *435 requestBody: required: true content: @@ -111783,9 +113471,9 @@ paths: description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111811,8 +113499,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: - - *754 - - *415 + - *773 + - *432 - 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. @@ -111838,9 +113526,9 @@ paths: application/json: schema: type: array - items: *419 + items: *436 examples: - default: *421 + default: *438 headers: Link: *41 x-github: @@ -111869,8 +113557,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: - - *754 - - *415 + - *773 + - *432 requestBody: required: true content: @@ -111902,9 +113590,9 @@ paths: description: Response content: application/json: - schema: *419 + schema: *436 examples: - default: *420 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111928,7 +113616,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *754 + - *773 - *17 - *19 responses: @@ -111938,9 +113626,9 @@ paths: application/json: schema: type: array - items: *328 + items: *346 examples: - default: *329 + default: *347 headers: Link: *41 x-github: @@ -111966,7 +113654,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *754 + - *773 - name: role description: Filters members returned by their role in the team. in: query @@ -111989,7 +113677,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '404': *6 @@ -112017,8 +113705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *754 - - *178 + - *773 + - *194 responses: '204': description: if user is a member @@ -112054,8 +113742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *754 - - *178 + - *773 + - *194 responses: '204': description: Response @@ -112094,8 +113782,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *754 - - *178 + - *773 + - *194 responses: '204': description: Response @@ -112131,16 +113819,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: - - *754 - - *178 + - *773 + - *194 responses: '200': description: Response content: application/json: - schema: *427 + schema: *444 examples: - response-if-user-is-a-team-maintainer: *759 + response-if-user-is-a-team-maintainer: *778 '404': *6 x-github: githubCloudOnly: false @@ -112173,8 +113861,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: - - *754 - - *178 + - *773 + - *194 requestBody: required: false content: @@ -112199,9 +113887,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *444 examples: - response-if-users-membership-with-team-is-now-pending: *760 + response-if-users-membership-with-team-is-now-pending: *779 '403': description: Forbidden if team synchronization is set up '422': @@ -112235,8 +113923,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: - - *754 - - *178 + - *773 + - *194 responses: '204': description: Response @@ -112264,7 +113952,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *754 + - *773 - *17 - *19 responses: @@ -112274,9 +113962,9 @@ paths: application/json: schema: type: array - items: *428 + items: *445 examples: - default: *761 + default: *780 headers: Link: *41 '404': *6 @@ -112302,16 +113990,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: - - *754 - - *429 + - *773 + - *446 responses: '200': description: Response content: application/json: - schema: *428 + schema: *445 examples: - default: *762 + default: *781 '404': description: Not Found if project is not managed by this team x-github: @@ -112335,8 +114023,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: - - *754 - - *429 + - *773 + - *446 requestBody: required: false content: @@ -112403,8 +114091,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: - - *754 - - *429 + - *773 + - *446 responses: '204': description: Response @@ -112431,7 +114119,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *754 + - *773 - *17 - *19 responses: @@ -112441,9 +114129,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 '404': *6 @@ -112473,15 +114161,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: - - *754 - - *430 - - *431 + - *773 + - *447 + - *448 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *763 + schema: *782 examples: alternative-response-with-extra-repository-information: value: @@ -112632,9 +114320,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: - - *754 - - *430 - - *431 + - *773 + - *447 + - *448 requestBody: required: false content: @@ -112684,9 +114372,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: - - *754 - - *430 - - *431 + - *773 + - *447 + - *448 responses: '204': description: Response @@ -112715,15 +114403,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: - - *754 + - *773 responses: '200': description: Response content: application/json: - schema: *432 + schema: *449 examples: - default: *433 + default: *450 '403': *27 '404': *6 x-github: @@ -112750,7 +114438,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: - - *754 + - *773 requestBody: required: true content: @@ -112811,7 +114499,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *449 examples: default: value: @@ -112842,7 +114530,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *754 + - *773 - *17 - *19 responses: @@ -112852,9 +114540,9 @@ paths: application/json: schema: type: array - items: *273 + items: *293 examples: - response-if-child-teams-exist: *764 + response-if-child-teams-exist: *783 headers: Link: *41 '404': *6 @@ -112887,7 +114575,7 @@ paths: application/json: schema: oneOf: - - &766 + - &785 title: Private User description: Private User type: object @@ -113137,7 +114825,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *765 + - *784 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -113297,7 +114985,7 @@ paths: description: Response content: application/json: - schema: *766 + schema: *785 examples: default: value: @@ -113376,7 +115064,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 '304': *35 '404': *6 '403': *27 @@ -113399,7 +115087,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: - - *178 + - *194 responses: '204': description: If the user is blocked @@ -113427,7 +115115,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *178 + - *194 responses: '204': description: Response @@ -113451,7 +115139,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *178 + - *194 responses: '204': description: Response @@ -113500,9 +115188,9 @@ paths: type: integer codespaces: type: array - items: *336 + items: *354 examples: - default: *337 + default: *355 '304': *35 '500': *38 '401': *23 @@ -113641,21 +115329,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '401': *23 '403': *27 '404': *6 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113695,7 +115383,7 @@ paths: type: integer secrets: type: array - items: &767 + items: &786 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -113737,7 +115425,7 @@ paths: - visibility - selected_repositories_url examples: - default: *538 + default: *555 headers: Link: *41 x-github: @@ -113809,13 +115497,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: - - *256 + - *276 responses: '200': description: Response content: application/json: - schema: *767 + schema: *786 examples: default: value: @@ -113845,7 +115533,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: - - *256 + - *276 requestBody: required: true content: @@ -113890,7 +115578,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -113918,7 +115606,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: - - *256 + - *276 responses: '204': description: Response @@ -113943,7 +115631,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: - - *256 + - *276 responses: '200': description: Response @@ -113959,9 +115647,9 @@ paths: type: integer repositories: type: array - items: *246 + items: *266 examples: - default: *768 + default: *787 '401': *23 '403': *27 '404': *6 @@ -113986,7 +115674,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: - - *256 + - *276 requestBody: required: true content: @@ -114040,7 +115728,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: - - *256 + - *276 - name: repository_id in: path required: true @@ -114073,7 +115761,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: - - *256 + - *276 - name: repository_id in: path required: true @@ -114105,15 +115793,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: - - *338 + - *356 responses: '200': description: Response content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '304': *35 '500': *38 '401': *23 @@ -114139,7 +115827,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: - - *338 + - *356 requestBody: required: false content: @@ -114169,9 +115857,9 @@ paths: description: Response content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '401': *23 '403': *27 '404': *6 @@ -114193,7 +115881,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: - - *338 + - *356 responses: '202': *37 '304': *35 @@ -114222,13 +115910,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: - - *338 + - *356 responses: '202': description: Response content: application/json: - schema: &769 + schema: &788 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -114281,7 +115969,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &770 + default: &789 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -114313,7 +116001,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *338 + - *356 - name: export_id in: path required: true @@ -114326,9 +116014,9 @@ paths: description: Response content: application/json: - schema: *769 + schema: *788 examples: - default: *770 + default: *789 '404': *6 x-github: githubCloudOnly: false @@ -114349,7 +116037,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *338 + - *356 responses: '200': description: Response @@ -114365,9 +116053,9 @@ paths: type: integer machines: type: array - items: *537 + items: *554 examples: - default: *771 + default: *790 '304': *35 '500': *38 '401': *23 @@ -114396,7 +116084,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: - - *338 + - *356 requestBody: required: true content: @@ -114452,11 +116140,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *443 + repository: *460 machine: anyOf: - type: 'null' - - *537 + - *554 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -115253,15 +116941,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: - - *338 + - *356 responses: '200': description: Response content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '304': *35 '500': *38 '400': *14 @@ -115273,7 +116961,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *107 + '409': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -115293,15 +116981,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: - - *338 + - *356 responses: '200': description: Response content: application/json: - schema: *336 + schema: *354 examples: - default: *536 + default: *553 '500': *38 '401': *23 '403': *27 @@ -115331,9 +117019,9 @@ paths: application/json: schema: type: array - items: *346 + items: *364 examples: - default: &783 + default: &801 value: - id: 197 name: hello_docker @@ -115434,7 +117122,7 @@ paths: application/json: schema: type: array - items: &772 + items: &791 title: Email description: Email type: object @@ -115504,9 +117192,9 @@ paths: application/json: schema: type: array - items: *772 + items: *791 examples: - default: &785 + default: &803 value: - email: octocat@github.com verified: true @@ -115583,7 +117271,7 @@ paths: application/json: schema: type: array - items: *772 + items: *791 examples: default: value: @@ -115695,7 +117383,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '304': *35 @@ -115728,7 +117416,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 '304': *35 @@ -115750,7 +117438,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: - - *178 + - *194 responses: '204': description: if the person is followed by the authenticated user @@ -115780,7 +117468,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *178 + - *194 responses: '204': description: Response @@ -115805,7 +117493,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *178 + - *194 responses: '204': description: Response @@ -115841,7 +117529,7 @@ paths: application/json: schema: type: array - items: &773 + items: &792 title: GPG Key description: A unique encryption key type: object @@ -115986,7 +117674,7 @@ paths: - subkeys - revoked examples: - default: &799 + default: &817 value: - id: 3 name: Octocat's GPG Key @@ -116071,9 +117759,9 @@ paths: description: Response content: application/json: - schema: *773 + schema: *792 examples: - default: &774 + default: &793 value: id: 3 name: Octocat's GPG Key @@ -116130,7 +117818,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: - - &775 + - &794 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -116142,9 +117830,9 @@ paths: description: Response content: application/json: - schema: *773 + schema: *792 examples: - default: *774 + default: *793 '404': *6 '304': *35 '403': *27 @@ -116167,7 +117855,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: - - *775 + - *794 responses: '204': description: Response @@ -116356,9 +118044,9 @@ paths: type: string repositories: type: array - items: *67 + items: *72 examples: - default: *241 + default: *261 headers: Link: *41 '404': *6 @@ -116383,7 +118071,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *240 + - *260 responses: '204': description: Response @@ -116409,7 +118097,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *240 + - *260 responses: '204': description: Response @@ -116443,12 +118131,12 @@ paths: application/json: schema: anyOf: - - *326 + - *344 - type: object properties: {} additionalProperties: false examples: - default: *327 + default: *345 '204': description: Response when there are no restrictions x-github: @@ -116472,7 +118160,7 @@ paths: required: true content: application/json: - schema: *614 + schema: *631 examples: default: value: @@ -116483,7 +118171,7 @@ paths: description: Response content: application/json: - schema: *326 + schema: *344 examples: default: value: @@ -116564,7 +118252,7 @@ paths: - closed - all default: open - - *334 + - *352 - name: sort description: What to sort results by. in: query @@ -116576,8 +118264,8 @@ paths: - updated - comments default: created - - *99 - - *189 + - *104 + - *206 - *17 - *19 responses: @@ -116587,9 +118275,9 @@ paths: application/json: schema: type: array - items: *183 + items: *200 examples: - default: *335 + default: *353 headers: Link: *41 '404': *6 @@ -116622,7 +118310,7 @@ paths: application/json: schema: type: array - items: &776 + items: &795 title: Key description: Key type: object @@ -116725,9 +118413,9 @@ paths: description: Response content: application/json: - schema: *776 + schema: *795 examples: - default: &777 + default: &796 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -116760,15 +118448,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: - - *640 + - *657 responses: '200': description: Response content: application/json: - schema: *776 + schema: *795 examples: - default: *777 + default: *796 '404': *6 '304': *35 '403': *27 @@ -116791,7 +118479,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: - - *640 + - *657 responses: '204': description: Response @@ -116824,7 +118512,7 @@ paths: application/json: schema: type: array - items: &778 + items: &797 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -116892,7 +118580,7 @@ paths: - id - type - login - plan: *200 + plan: *217 required: - billing_cycle - next_billing_date @@ -116903,7 +118591,7 @@ paths: - account - plan examples: - default: &779 + default: &798 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -116965,9 +118653,9 @@ paths: application/json: schema: type: array - items: *778 + items: *797 examples: - default: *779 + default: *798 headers: Link: *41 '304': *35 @@ -117007,7 +118695,7 @@ paths: application/json: schema: type: array - items: *339 + items: *357 examples: default: value: @@ -117109,13 +118797,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: - - *76 + - *81 responses: '200': description: Response content: application/json: - schema: *339 + schema: *357 examples: default: value: @@ -117173,7 +118861,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: - - *76 + - *81 requestBody: required: true content: @@ -117198,7 +118886,7 @@ paths: description: Response content: application/json: - schema: *339 + schema: *357 examples: default: value: @@ -117266,7 +118954,7 @@ paths: application/json: schema: type: array - items: *341 + items: *359 examples: default: value: @@ -117528,7 +119216,7 @@ paths: description: Response content: application/json: - schema: *341 + schema: *359 examples: default: value: @@ -117708,7 +119396,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *342 + - *360 - name: exclude in: query required: false @@ -117721,7 +119409,7 @@ paths: description: Response content: application/json: - schema: *341 + schema: *359 examples: default: value: @@ -117915,7 +119603,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *342 + - *360 responses: '302': description: Response @@ -117941,7 +119629,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *342 + - *360 responses: '204': description: Response @@ -117970,8 +119658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *342 - - *780 + - *360 + - *799 responses: '204': description: Response @@ -117995,7 +119683,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *342 + - *360 - *17 - *19 responses: @@ -118005,9 +119693,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 '404': *6 @@ -118042,9 +119730,9 @@ paths: application/json: schema: type: array - items: *62 + items: *67 examples: - default: *781 + default: *230 headers: Link: *41 '304': *35 @@ -118086,7 +119774,7 @@ paths: - docker - nuget - container - - *782 + - *800 - *19 - *17 responses: @@ -118096,10 +119784,10 @@ paths: application/json: schema: type: array - items: *346 + items: *364 examples: - default: *783 - '400': *784 + default: *801 + '400': *802 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118119,16 +119807,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: - - *348 - - *349 + - *366 + - *367 responses: '200': description: Response content: application/json: - schema: *346 + schema: *364 examples: - default: &800 + default: &818 value: id: 40201 name: octo-name @@ -118241,8 +119929,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: - - *348 - - *349 + - *366 + - *367 responses: '204': description: Response @@ -118272,8 +119960,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: - - *348 - - *349 + - *366 + - *367 - name: token description: package token schema: @@ -118305,8 +119993,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: - - *348 - - *349 + - *366 + - *367 - *19 - *17 - name: state @@ -118326,7 +120014,7 @@ paths: application/json: schema: type: array - items: *350 + items: *368 examples: default: value: @@ -118375,15 +120063,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: - - *348 - - *349 - - *351 + - *366 + - *367 + - *369 responses: '200': description: Response content: application/json: - schema: *350 + schema: *368 examples: default: value: @@ -118419,9 +120107,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: - - *348 - - *349 - - *351 + - *366 + - *367 + - *369 responses: '204': description: Response @@ -118451,9 +120139,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: - - *348 - - *349 - - *351 + - *366 + - *367 + - *369 responses: '204': description: Response @@ -118511,7 +120199,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *380 examples: default: value: @@ -118583,9 +120271,9 @@ paths: application/json: schema: type: array - items: *772 + items: *791 examples: - default: *785 + default: *803 headers: Link: *41 '304': *35 @@ -118696,9 +120384,9 @@ paths: application/json: schema: type: array - items: *67 + items: *72 examples: - default: &792 + default: &810 summary: Default response value: - id: 1296269 @@ -119016,9 +120704,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *460 examples: - default: *445 + default: *462 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -119056,9 +120744,9 @@ paths: application/json: schema: type: array - items: *616 + items: *633 examples: - default: *786 + default: *804 headers: Link: *41 '304': *35 @@ -119081,12 +120769,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *330 + - *348 responses: '204': description: Response '403': *27 - '409': *107 + '409': *112 '404': *6 '304': *35 x-github: @@ -119104,11 +120792,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *330 + - *348 responses: '204': description: Response - '409': *107 + '409': *112 '304': *35 '404': *6 '403': *27 @@ -119137,7 +120825,7 @@ paths: application/json: schema: type: array - items: &787 + items: &805 title: Social account description: Social media account type: object @@ -119154,7 +120842,7 @@ paths: - provider - url examples: - default: &788 + default: &806 value: - provider: twitter url: https://twitter.com/github @@ -119217,9 +120905,9 @@ paths: application/json: schema: type: array - items: *787 + items: *805 examples: - default: *788 + default: *806 '422': *15 '304': *35 '404': *6 @@ -119307,7 +120995,7 @@ paths: application/json: schema: type: array - items: &789 + items: &807 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -119327,7 +121015,7 @@ paths: - title - created_at examples: - default: &803 + default: &821 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -119394,9 +121082,9 @@ paths: description: Response content: application/json: - schema: *789 + schema: *807 examples: - default: &790 + default: &808 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -119427,7 +121115,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: - - &791 + - &809 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -119439,9 +121127,9 @@ paths: description: Response content: application/json: - schema: *789 + schema: *807 examples: - default: *790 + default: *808 '404': *6 '304': *35 '403': *27 @@ -119464,7 +121152,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: - - *791 + - *809 responses: '204': description: Response @@ -119493,7 +121181,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: - - &804 + - &822 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 @@ -119506,7 +121194,7 @@ paths: - created - updated default: created - - *99 + - *104 - *17 - *19 responses: @@ -119516,13 +121204,13 @@ paths: application/json: schema: type: array - items: *67 + items: *72 examples: - default-response: *792 + default-response: *810 application/vnd.github.v3.star+json: schema: type: array - items: &805 + items: &823 title: Starred Repository description: Starred Repository type: object @@ -119530,7 +121218,7 @@ paths: starred_at: type: string format: date-time - repo: *67 + repo: *72 required: - starred_at - repo @@ -119678,8 +121366,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response if this repository is starred by you @@ -119707,8 +121395,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -119732,8 +121420,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: - - *430 - - *431 + - *447 + - *448 responses: '204': description: Response @@ -119766,9 +121454,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 '304': *35 @@ -119805,7 +121493,7 @@ paths: application/json: schema: type: array - items: *411 + items: *428 examples: default: value: @@ -119883,7 +121571,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *202 + - *219 responses: '200': description: Response @@ -119891,10 +121579,10 @@ paths: application/json: schema: oneOf: - - *766 - - *765 + - *785 + - *784 examples: - default-response: &794 + default-response: &812 summary: Default response value: login: octocat @@ -119929,7 +121617,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &795 + response-with-git-hub-plan-information: &813 summary: Response with GitHub plan information value: login: octocat @@ -119989,7 +121677,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *793 + - *811 - *17 responses: '200': @@ -120000,7 +121688,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: example: ; rel="next" @@ -120030,7 +121718,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *178 + - *194 responses: '200': description: Response @@ -120038,11 +121726,11 @@ paths: application/json: schema: oneOf: - - *766 - - *765 + - *785 + - *784 examples: - default-response: *794 - response-with-git-hub-plan-information: *795 + default-response: *812 + response-with-git-hub-plan-information: *813 '404': *6 x-github: githubCloudOnly: false @@ -120066,9 +121754,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *97 - - *98 - - *178 + - *102 + - *103 + - *194 requestBody: required: true content: @@ -120091,8 +121779,8 @@ paths: required: - subject_digests examples: - default: *796 - withPredicateType: *797 + default: *814 + withPredicateType: *815 responses: '200': description: Response @@ -120146,7 +121834,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *798 + default: *816 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -120164,7 +121852,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk parameters: - - *178 + - *194 requestBody: required: true content: @@ -120229,7 +121917,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *178 + - *194 - name: subject_digest description: Subject Digest in: path @@ -120260,7 +121948,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id parameters: - - *178 + - *194 - name: attestation_id description: Attestation ID in: path @@ -120296,9 +121984,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations parameters: - *17 - - *97 - - *98 - - *178 + - *102 + - *103 + - *194 - name: subject_digest description: Subject Digest in: path @@ -120350,12 +122038,12 @@ paths: initiator: type: string examples: - default: *483 + default: *500 '201': description: Response content: application/json: - schema: *257 + schema: *277 examples: default: value: @@ -120381,7 +122069,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: - - *178 + - *194 responses: '200': description: Response @@ -120389,9 +122077,9 @@ paths: application/json: schema: type: array - items: *346 + items: *364 examples: - default: *783 + default: *801 '403': *27 '401': *23 x-github: @@ -120414,7 +122102,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120424,7 +122112,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -120486,8 +122174,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: - - *178 - - *76 + - *194 + - *81 - *17 - *19 responses: @@ -120497,7 +122185,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -120574,7 +122262,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120584,7 +122272,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -120642,7 +122330,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120654,7 +122342,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -120673,7 +122361,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120685,7 +122373,7 @@ paths: type: array items: *4 examples: - default: *177 + default: *193 headers: Link: *41 x-github: @@ -120704,7 +122392,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: - - *178 + - *194 - name: target_user in: path required: true @@ -120731,8 +122419,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *178 - - *189 + - *194 + - *206 - *17 - *19 responses: @@ -120742,9 +122430,9 @@ paths: application/json: schema: type: array - items: *190 + items: *207 examples: - default: *191 + default: *208 headers: Link: *41 '422': *15 @@ -120765,7 +122453,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: - - *178 + - *194 - *17 - *19 responses: @@ -120775,9 +122463,9 @@ paths: application/json: schema: type: array - items: *773 + items: *792 examples: - default: *799 + default: *817 headers: Link: *41 x-github: @@ -120801,7 +122489,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *178 + - *194 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -120873,7 +122561,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: - - *178 + - *194 responses: '200': description: Response @@ -120881,7 +122569,7 @@ paths: application/json: schema: *20 examples: - default: *613 + default: *630 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120899,7 +122587,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120955,7 +122643,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -120965,9 +122653,9 @@ paths: application/json: schema: type: array - items: *62 + items: *67 examples: - default: *781 + default: *230 headers: Link: *41 x-github: @@ -121006,8 +122694,8 @@ paths: - docker - nuget - container - - *782 - - *178 + - *800 + - *194 - *19 - *17 responses: @@ -121017,12 +122705,12 @@ paths: application/json: schema: type: array - items: *346 + items: *364 examples: - default: *783 + default: *801 '403': *27 '401': *23 - '400': *784 + '400': *802 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121042,17 +122730,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *348 - - *349 - - *178 + - *366 + - *367 + - *194 responses: '200': description: Response content: application/json: - schema: *346 + schema: *364 examples: - default: *800 + default: *818 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121073,9 +122761,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *348 - - *349 - - *178 + - *366 + - *367 + - *194 responses: '204': description: Response @@ -121107,9 +122795,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *348 - - *349 - - *178 + - *366 + - *367 + - *194 - name: token description: package token schema: @@ -121141,9 +122829,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: - - *348 - - *349 - - *178 + - *366 + - *367 + - *194 responses: '200': description: Response @@ -121151,7 +122839,7 @@ paths: application/json: schema: type: array - items: *350 + items: *368 examples: default: value: @@ -121209,16 +122897,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: - - *348 - - *349 - - *351 - - *178 + - *366 + - *367 + - *369 + - *194 responses: '200': description: Response content: application/json: - schema: *350 + schema: *368 examples: default: value: @@ -121253,10 +122941,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *348 - - *349 - - *178 - - *351 + - *366 + - *367 + - *194 + - *369 responses: '204': description: Response @@ -121288,10 +122976,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *348 - - *349 - - *178 - - *351 + - *366 + - *367 + - *194 + - *369 responses: '204': description: Response @@ -121317,7 +123005,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects parameters: - - *178 + - *194 - name: state description: Indicates the state of the projects to return. in: query @@ -121338,7 +123026,7 @@ paths: application/json: schema: type: array - items: *362 + items: *380 examples: default: value: @@ -121396,15 +123084,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user parameters: - - *178 + - *194 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *97 - - *98 + - *102 + - *103 - *17 responses: '200': @@ -121413,9 +123101,9 @@ paths: application/json: schema: type: array - items: *363 + items: *381 examples: - default: *364 + default: *382 headers: Link: *41 '304': *35 @@ -121437,16 +123125,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *365 - - *178 + - *383 + - *194 responses: '200': description: Response content: application/json: - schema: *363 + schema: *381 examples: - default: *364 + default: *382 headers: Link: *41 '304': *35 @@ -121468,11 +123156,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *365 - - *178 + - *383 + - *194 - *17 - - *97 - - *98 + - *102 + - *103 responses: '200': description: Response @@ -121480,9 +123168,9 @@ paths: application/json: schema: type: array - items: *366 + items: *384 examples: - default: *367 + default: *385 headers: Link: *41 '304': *35 @@ -121504,17 +123192,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *365 - - *801 - - *178 + - *383 + - *819 + - *194 responses: '200': description: Response content: application/json: - schema: *366 + schema: *384 examples: - default: *367 + default: *385 headers: Link: *41 '304': *35 @@ -121537,10 +123225,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: - - *365 - - *178 - - *97 - - *98 + - *383 + - *194 + - *102 + - *103 - *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) @@ -121550,17 +123238,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -121568,9 +123258,9 @@ paths: application/json: schema: type: array - items: *372 + items: *390 examples: - default: *373 + default: *391 headers: Link: *41 '304': *35 @@ -121591,8 +123281,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - - *178 - - *365 + - *194 + - *383 requestBody: required: true description: Details of the item to add to the project. @@ -121629,10 +123319,10 @@ paths: description: Response content: application/json: - schema: *802 + schema: *820 examples: - issue: *371 - pull_request: *371 + issue: *389 + pull_request: *389 '304': *35 '403': *27 '401': *23 @@ -121652,29 +123342,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: - - *365 - - *178 - - *374 + - *383 + - *194 + - *392 - 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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response content: application/json: - schema: *372 + schema: *390 examples: - default: *373 + default: *391 headers: Link: *41 '304': *35 @@ -121695,9 +123387,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *365 - - *178 - - *374 + - *383 + - *194 + - *392 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -121770,13 +123462,13 @@ paths: description: Response content: application/json: - schema: *372 + schema: *390 examples: - text_field: *373 - number_field: *373 - date_field: *373 - single_select_field: *373 - iteration_field: *373 + text_field: *391 + number_field: *391 + date_field: *391 + single_select_field: *391 + iteration_field: *391 '401': *23 '403': *27 '404': *6 @@ -121796,9 +123488,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *365 - - *178 - - *374 + - *383 + - *194 + - *392 responses: '204': description: Response @@ -121825,7 +123517,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: - - *178 + - *194 - *17 - *19 responses: @@ -121835,7 +123527,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -121900,7 +123592,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: - - *178 + - *194 - *17 - *19 responses: @@ -121910,7 +123602,7 @@ paths: application/json: schema: type: array - items: *208 + items: *225 examples: default: value: @@ -121973,7 +123665,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *178 + - *194 - name: type description: Limit results to repositories of the specified type. in: query @@ -122016,9 +123708,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -122042,15 +123734,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: - - *178 + - *194 responses: '200': description: Response content: application/json: - schema: *398 + schema: *415 examples: - default: *399 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122072,15 +123764,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: - - *178 + - *194 responses: '200': description: Response content: application/json: - schema: *403 + schema: *420 examples: - default: *404 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122089,7 +123781,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 @@ -122097,12 +123792,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: - - *178 - - *169 - - *213 - - *170 - - *215 - - *216 + - *194 + - *185 + - *231 + - *186 + - *233 + - *234 responses: '200': description: Response when getting a billing premium request usage report @@ -122155,19 +123850,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 @@ -122210,7 +123905,7 @@ paths: '403': *27 '404': *6 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -122232,15 +123927,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: - - *178 + - *194 responses: '200': description: Response content: application/json: - schema: *405 + schema: *422 examples: - default: *406 + default: *423 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122260,11 +123955,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: - - *178 - - *169 - - *217 - - *170 - - *218 + - *194 + - *185 + - *235 + - *186 + - *236 responses: '200': description: Response when getting a billing usage report @@ -122335,7 +124030,7 @@ paths: '400': *14 '403': *27 '500': *38 - '503': *163 + '503': *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -122353,7 +124048,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: - - *178 + - *194 - *17 - *19 responses: @@ -122363,9 +124058,9 @@ paths: application/json: schema: type: array - items: *787 + items: *805 examples: - default: *788 + default: *806 headers: Link: *41 x-github: @@ -122385,7 +124080,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: - - *178 + - *194 - *17 - *19 responses: @@ -122395,9 +124090,9 @@ paths: application/json: schema: type: array - items: *789 + items: *807 examples: - default: *803 + default: *821 headers: Link: *41 x-github: @@ -122421,9 +124116,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *178 - - *804 - - *99 + - *194 + - *822 + - *104 - *17 - *19 responses: @@ -122434,11 +124129,11 @@ paths: schema: anyOf: - type: array - items: *805 + items: *823 - type: array - items: *67 + items: *72 examples: - default-response: *792 + default-response: *810 headers: Link: *41 x-github: @@ -122457,7 +124152,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *178 + - *194 - *17 - *19 responses: @@ -122467,9 +124162,9 @@ paths: application/json: schema: type: array - items: *246 + items: *266 examples: - default: *352 + default: *370 headers: Link: *41 x-github: @@ -122598,7 +124293,7 @@ webhooks: type: string enum: - disabled - enterprise: &806 + enterprise: &824 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -122667,7 +124362,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &807 + installation: &825 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -122688,7 +124383,7 @@ webhooks: required: - id - node_id - organization: &808 + organization: &826 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -122761,7 +124456,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &809 + repository: &827 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -122790,7 +124485,7 @@ webhooks: license: anyOf: - type: 'null' - - *186 + - *203 organization: anyOf: - type: 'null' @@ -123674,10 +125369,10 @@ webhooks: type: string enum: - enabled - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -123753,11 +125448,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - rule: &810 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + rule: &828 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) @@ -123980,11 +125675,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - rule: *810 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + rule: *828 sender: *4 required: - action @@ -124172,11 +125867,11 @@ webhooks: - everyone required: - from - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - rule: *810 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + rule: *828 sender: *4 required: - action @@ -124247,7 +125942,7 @@ webhooks: required: true content: application/json: - schema: &813 + schema: &831 title: Exemption request cancellation event type: object properties: @@ -124255,11 +125950,11 @@ webhooks: type: string enum: - cancelled - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - exemption_request: &811 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + exemption_request: &829 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -124497,7 +126192,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &812 + items: &830 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -124607,7 +126302,7 @@ webhooks: required: true content: application/json: - schema: &814 + schema: &832 title: Exemption request completed event type: object properties: @@ -124615,11 +126310,11 @@ webhooks: type: string enum: - completed - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - exemption_request: *811 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + exemption_request: *829 sender: *4 required: - action @@ -124689,7 +126384,7 @@ webhooks: required: true content: application/json: - schema: &815 + schema: &833 title: Exemption request created event type: object properties: @@ -124697,11 +126392,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - exemption_request: *811 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + exemption_request: *829 sender: *4 required: - action @@ -124771,7 +126466,7 @@ webhooks: required: true content: application/json: - schema: &816 + schema: &834 title: Exemption response dismissed event type: object properties: @@ -124779,12 +126474,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - exemption_request: *811 - exemption_response: *812 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + exemption_request: *829 + exemption_response: *830 sender: *4 required: - action @@ -124856,7 +126551,7 @@ webhooks: required: true content: application/json: - schema: &817 + schema: &835 title: Exemption response submitted event type: object properties: @@ -124864,12 +126559,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - exemption_request: *811 - exemption_response: *812 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + exemption_request: *829 + exemption_response: *830 sender: *4 required: - action @@ -124942,7 +126637,7 @@ webhooks: required: true content: application/json: - schema: *813 + schema: *831 responses: '200': description: Return a 200 status to indicate that the data was received @@ -125009,7 +126704,7 @@ webhooks: required: true content: application/json: - schema: *814 + schema: *832 responses: '200': description: Return a 200 status to indicate that the data was received @@ -125076,7 +126771,7 @@ webhooks: required: true content: application/json: - schema: *815 + schema: *833 responses: '200': description: Return a 200 status to indicate that the data was received @@ -125143,7 +126838,7 @@ webhooks: required: true content: application/json: - schema: *816 + schema: *834 responses: '200': description: Return a 200 status to indicate that the data was received @@ -125211,7 +126906,7 @@ webhooks: required: true content: application/json: - schema: *817 + schema: *835 responses: '200': description: Return a 200 status to indicate that the data was received @@ -125289,7 +126984,7 @@ webhooks: type: string enum: - completed - check_run: &819 + check_run: &837 title: CheckRun description: A check performed on the code of a given code change type: object @@ -125354,8 +127049,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *187 - repository: *246 + items: *204 + repository: *266 status: type: string enum: @@ -125399,7 +127094,7 @@ webhooks: - examples: - neutral - deployment: *818 + deployment: *836 details_url: type: string examples: @@ -125459,7 +127154,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *187 + items: *204 started_at: type: string format: date-time @@ -125497,10 +127192,10 @@ webhooks: - output - app - pull_requests - installation: *807 - enterprise: *806 - organization: *808 - repository: *809 + installation: *825 + enterprise: *824 + organization: *826 + repository: *827 sender: *4 required: - check_run @@ -125893,11 +127588,11 @@ webhooks: type: string enum: - created - check_run: *819 - installation: *807 - enterprise: *806 - organization: *808 - repository: *809 + check_run: *837 + installation: *825 + enterprise: *824 + organization: *826 + repository: *827 sender: *4 required: - check_run @@ -126293,11 +127988,11 @@ webhooks: type: string enum: - requested_action - check_run: *819 - installation: *807 - enterprise: *806 - organization: *808 - repository: *809 + check_run: *837 + installation: *825 + enterprise: *824 + organization: *826 + repository: *827 requested_action: description: The action requested by the user. type: object @@ -126702,11 +128397,11 @@ webhooks: type: string enum: - rerequested - check_run: *819 - installation: *807 - enterprise: *806 - organization: *808 - repository: *809 + check_run: *837 + installation: *825 + enterprise: *824 + organization: *826 + repository: *827 sender: *4 required: - check_run @@ -127698,10 +129393,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -128386,10 +130081,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -129068,10 +130763,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -129240,7 +130935,7 @@ webhooks: required: - login - id - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -129392,20 +131087,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &820 + commit_oid: &838 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: *806 - installation: *807 - organization: *808 - ref: &821 + enterprise: *824 + installation: *825 + organization: *826 + ref: &839 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: *809 + repository: *827 sender: *4 required: - action @@ -129572,7 +131267,7 @@ webhooks: required: - login - id - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -129813,12 +131508,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *820 - enterprise: *806 - installation: *807 - organization: *808 - ref: *821 - repository: *809 + commit_oid: *838 + enterprise: *824 + installation: *825 + organization: *826 + ref: *839 + repository: *827 sender: *4 required: - action @@ -129916,7 +131611,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -130101,12 +131796,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *820 - enterprise: *806 - installation: *807 - organization: *808 - ref: *821 - repository: *809 + commit_oid: *838 + enterprise: *824 + installation: *825 + organization: *826 + ref: *839 + repository: *827 sender: *4 required: - action @@ -130275,7 +131970,7 @@ webhooks: required: - login - id - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -130452,12 +132147,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *820 - enterprise: *806 - installation: *807 - organization: *808 - ref: *821 - repository: *809 + commit_oid: *838 + enterprise: *824 + installation: *825 + organization: *826 + ref: *839 + repository: *827 sender: *4 required: - action @@ -130560,7 +132255,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -130740,9 +132435,9 @@ webhooks: type: - string - 'null' - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -130750,7 +132445,7 @@ webhooks: type: - string - 'null' - repository: *809 + repository: *827 sender: *4 required: - action @@ -130849,7 +132544,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *511 + dismissed_comment: *528 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -130996,12 +132691,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *820 - enterprise: *806 - installation: *807 - organization: *808 - ref: *821 - repository: *809 + commit_oid: *838 + enterprise: *824 + installation: *825 + organization: *826 + ref: *839 + repository: *827 sender: *4 required: - action @@ -131263,10 +132958,10 @@ webhooks: - updated_at - author_association - body - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -131347,18 +133042,18 @@ webhooks: type: - string - 'null' - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *808 - pusher_type: &822 + organization: *826 + pusher_type: &840 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &823 + ref: &841 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -131368,7 +133063,7 @@ webhooks: enum: - tag - branch - repository: *809 + repository: *827 sender: *4 required: - ref @@ -131450,10 +133145,10 @@ webhooks: type: string enum: - created - definition: *125 - enterprise: *806 - installation: *807 - organization: *808 + definition: *141 + enterprise: *824 + installation: *825 + organization: *826 sender: *4 required: - action @@ -131538,9 +133233,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 sender: *4 required: - action @@ -131617,10 +133312,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *125 - enterprise: *806 - installation: *807 - organization: *808 + definition: *141 + enterprise: *824 + installation: *825 + organization: *826 sender: *4 required: - action @@ -131697,10 +133392,10 @@ webhooks: type: string enum: - updated - definition: *125 - enterprise: *806 - installation: *807 - organization: *808 + definition: *141 + enterprise: *824 + installation: *825 + organization: *826 sender: *4 required: - action @@ -131777,19 +133472,19 @@ webhooks: type: string enum: - updated - enterprise: *806 - installation: *807 - repository: *809 - organization: *808 + enterprise: *824 + installation: *825 + repository: *827 + organization: *826 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *376 + items: *140 old_property_values: type: array description: The old custom property values for the repository. - items: *376 + items: *140 required: - action - repository @@ -131865,18 +133560,18 @@ webhooks: title: delete event type: object properties: - enterprise: *806 - installation: *807 - organization: *808 - pusher_type: *822 - ref: *823 + enterprise: *824 + installation: *825 + organization: *826 + pusher_type: *840 + ref: *841 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *809 + repository: *827 sender: *4 required: - ref @@ -131960,11 +133655,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132048,11 +133743,11 @@ webhooks: type: string enum: - auto_reopened - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132136,11 +133831,11 @@ webhooks: type: string enum: - created - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132222,11 +133917,11 @@ webhooks: type: string enum: - dismissed - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132308,11 +134003,11 @@ webhooks: type: string enum: - fixed - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132395,11 +134090,11 @@ webhooks: type: string enum: - reintroduced - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132481,11 +134176,11 @@ webhooks: type: string enum: - reopened - alert: *563 - installation: *807 - organization: *808 - enterprise: *806 - repository: *809 + alert: *580 + installation: *825 + organization: *826 + enterprise: *824 + repository: *827 sender: *4 required: - action @@ -132562,9 +134257,9 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - key: &824 + enterprise: *824 + installation: *825 + key: &842 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -132602,8 +134297,8 @@ webhooks: - verified - created_at - read_only - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -132680,11 +134375,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - key: *824 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + key: *842 + organization: *826 + repository: *827 sender: *4 required: - action @@ -133256,12 +134951,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - workflow: &828 + workflow: &846 title: Workflow type: - object @@ -133999,13 +135694,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *569 + deployment: *586 pull_requests: type: array - items: *658 - repository: *809 - organization: *808 - installation: *807 + items: *677 + repository: *827 + organization: *826 + installation: *825 sender: *4 responses: '200': @@ -134076,7 +135771,7 @@ webhooks: type: string enum: - approved - approver: &825 + approver: &843 type: object properties: avatar_url: @@ -134119,11 +135814,11 @@ webhooks: type: string comment: type: string - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - reviewers: &826 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + reviewers: &844 type: array items: type: object @@ -134204,7 +135899,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &827 + workflow_job_run: &845 type: object properties: conclusion: @@ -134950,18 +136645,18 @@ webhooks: type: string enum: - rejected - approver: *825 + approver: *843 comment: type: string - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - reviewers: *826 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + reviewers: *844 sender: *4 since: type: string - workflow_job_run: *827 + workflow_job_run: *845 workflow_job_runs: type: array items: @@ -135678,13 +137373,13 @@ webhooks: type: string enum: - requested - enterprise: *806 + enterprise: *824 environment: type: string - installation: *807 - organization: *808 - repository: *809 - requestor: &833 + installation: *825 + organization: *826 + repository: *827 + requestor: &851 title: User type: - object @@ -137627,12 +139322,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - workflow: *828 + workflow: *846 workflow_run: title: Deployment Workflow Run type: @@ -138323,7 +140018,7 @@ webhooks: type: string enum: - answered - answer: &831 + answer: &849 type: object properties: author_association: @@ -138483,11 +140178,11 @@ webhooks: - created_at - updated_at - body - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -138614,11 +140309,11 @@ webhooks: - from required: - category - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -138701,11 +140396,11 @@ webhooks: type: string enum: - closed - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -138787,7 +140482,7 @@ webhooks: type: string enum: - created - comment: &830 + comment: &848 type: object properties: author_association: @@ -138947,11 +140642,11 @@ webhooks: - updated_at - body - reactions - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139034,12 +140729,12 @@ webhooks: type: string enum: - deleted - comment: *830 - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + comment: *848 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139134,12 +140829,12 @@ webhooks: - from required: - body - comment: *830 - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + comment: *848 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139223,11 +140918,11 @@ webhooks: type: string enum: - created - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139309,11 +141004,11 @@ webhooks: type: string enum: - deleted - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139413,11 +141108,11 @@ webhooks: type: string required: - from - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139499,10 +141194,10 @@ webhooks: type: string enum: - labeled - discussion: *829 - enterprise: *806 - installation: *807 - label: &832 + discussion: *847 + enterprise: *824 + installation: *825 + label: &850 title: Label type: object properties: @@ -139535,8 +141230,8 @@ webhooks: - color - default - description - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139619,11 +141314,11 @@ webhooks: type: string enum: - locked - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139705,11 +141400,11 @@ webhooks: type: string enum: - pinned - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139791,11 +141486,11 @@ webhooks: type: string enum: - reopened - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139880,16 +141575,16 @@ webhooks: changes: type: object properties: - new_discussion: *829 - new_repository: *809 + new_discussion: *847 + new_repository: *827 required: - new_discussion - new_repository - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -139972,10 +141667,10 @@ webhooks: type: string enum: - unanswered - discussion: *829 - old_answer: *831 - organization: *808 - repository: *809 + discussion: *847 + old_answer: *849 + organization: *826 + repository: *827 sender: *4 required: - action @@ -140057,12 +141752,12 @@ webhooks: type: string enum: - unlabeled - discussion: *829 - enterprise: *806 - installation: *807 - label: *832 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -140145,11 +141840,11 @@ webhooks: type: string enum: - unlocked - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -140231,11 +141926,11 @@ webhooks: type: string enum: - unpinned - discussion: *829 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + discussion: *847 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -140304,7 +141999,7 @@ webhooks: required: true content: application/json: - schema: *815 + schema: *833 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140367,7 +142062,7 @@ webhooks: required: true content: application/json: - schema: *817 + schema: *835 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140433,7 +142128,7 @@ webhooks: required: true content: application/json: - schema: *813 + schema: *831 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140499,7 +142194,7 @@ webhooks: required: true content: application/json: - schema: *814 + schema: *832 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140565,7 +142260,7 @@ webhooks: required: true content: application/json: - schema: *815 + schema: *833 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140631,7 +142326,7 @@ webhooks: required: true content: application/json: - schema: *816 + schema: *834 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140697,7 +142392,7 @@ webhooks: required: true content: application/json: - schema: *817 + schema: *835 responses: '200': description: Return a 200 status to indicate that the data was received @@ -140764,7 +142459,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *806 + enterprise: *824 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -141442,9 +143137,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *807 - organization: *808 - repository: *809 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - forkee @@ -141590,9 +143285,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pages: description: The pages that were updated. type: array @@ -141630,7 +143325,7 @@ webhooks: - action - sha - html_url - repository: *809 + repository: *827 sender: *4 required: - pages @@ -141706,10 +143401,10 @@ webhooks: type: string enum: - created - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories: &834 + organization: *826 + repositories: &852 description: An array of repository objects that the installation can access. type: array @@ -141735,8 +143430,8 @@ webhooks: - name - full_name - private - repository: *809 - requester: *833 + repository: *827 + requester: *851 sender: *4 required: - action @@ -141811,11 +143506,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories: *834 - repository: *809 + organization: *826 + repositories: *852 + repository: *827 requester: type: - 'null' @@ -141892,11 +143587,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories: *834 - repository: *809 + organization: *826 + repositories: *852 + repository: *827 requester: type: - 'null' @@ -141973,10 +143668,10 @@ webhooks: type: string enum: - added - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories_added: &835 + organization: *826 + repositories_added: &853 description: An array of repository objects, which were added to the installation. type: array @@ -142022,15 +143717,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *809 - repository_selection: &836 + repository: *827 + repository_selection: &854 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *833 + requester: *851 sender: *4 required: - action @@ -142109,10 +143804,10 @@ webhooks: type: string enum: - removed - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories_added: *835 + organization: *826 + repositories_added: *853 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -142139,9 +143834,9 @@ webhooks: - name - full_name - private - repository: *809 - repository_selection: *836 - requester: *833 + repository: *827 + repository_selection: *854 + requester: *851 sender: *4 required: - action @@ -142220,11 +143915,11 @@ webhooks: type: string enum: - suspend - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories: *834 - repository: *809 + organization: *826 + repositories: *852 + repository: *827 requester: type: - 'null' @@ -142407,10 +144102,10 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 target_type: type: string @@ -142489,11 +144184,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *806 + enterprise: *824 installation: *20 - organization: *808 - repositories: *834 - repository: *809 + organization: *826 + repositories: *852 + repository: *827 requester: type: - 'null' @@ -142741,8 +144436,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -143559,8 +145254,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143577,7 +145272,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -143921,8 +145616,8 @@ webhooks: - state - locked - assignee - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -144002,7 +145697,7 @@ webhooks: type: string enum: - deleted - comment: &837 + comment: &855 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -144169,8 +145864,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -144983,8 +146678,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145001,7 +146696,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -145347,8 +147042,8 @@ webhooks: - state - locked - assignee - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -145428,7 +147123,7 @@ webhooks: type: string enum: - edited - changes: &861 + changes: &879 description: The changes to the comment. type: object properties: @@ -145440,9 +147135,9 @@ webhooks: type: string required: - from - comment: *837 - enterprise: *806 - installation: *807 + comment: *855 + enterprise: *824 + installation: *825 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -146258,8 +147953,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146276,7 +147971,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -146620,8 +148315,8 @@ webhooks: - state - locked - assignee - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -146705,15 +148400,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *183 + blocked_issue: *200 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *183 - blocking_issue_repo: *67 - installation: *807 - organization: *808 - repository: *809 + blocking_issue: *200 + blocking_issue_repo: *72 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -146801,15 +148496,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *183 + blocked_issue: *200 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *183 - blocking_issue_repo: *67 - installation: *807 - organization: *808 - repository: *809 + blocking_issue: *200 + blocking_issue_repo: *72 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -146896,15 +148591,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *183 - blocked_issue_repo: *67 + blocked_issue: *200 + blocked_issue_repo: *72 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *183 - installation: *807 - organization: *808 - repository: *809 + blocking_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -146992,15 +148687,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *183 - blocked_issue_repo: *67 + blocked_issue: *200 + blocked_issue_repo: *72 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *183 - installation: *807 - organization: *808 - repository: *809 + blocking_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -147085,10 +148780,10 @@ webhooks: type: string enum: - assigned - assignee: *833 - enterprise: *806 - installation: *807 - issue: &840 + assignee: *851 + enterprise: *824 + installation: *825 + issue: &858 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -147900,11 +149595,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147921,7 +149616,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -148024,8 +149719,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -148105,8 +149800,8 @@ webhooks: type: string enum: - closed - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -148923,11 +150618,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148944,7 +150639,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -149190,8 +150885,8 @@ webhooks: required: - state - closed_at - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -149270,8 +150965,8 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150079,11 +151774,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150100,7 +151795,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -150202,8 +151897,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -150282,8 +151977,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151114,11 +152809,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151135,7 +152830,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -151216,7 +152911,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &838 + milestone: &856 title: Milestone description: A collection of related issues and pull requests. type: object @@ -151359,8 +153054,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -151459,8 +153154,8 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152272,11 +153967,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152290,7 +153985,7 @@ webhooks: timeline_url: type: string format: uri - type: *331 + type: *349 title: description: Title of the issue type: string @@ -152396,9 +154091,9 @@ webhooks: - active_lock_reason - body - reactions - label: *832 - organization: *808 - repository: *809 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -152478,8 +154173,8 @@ webhooks: type: string enum: - labeled - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153290,11 +154985,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153308,7 +155003,7 @@ webhooks: timeline_url: type: string format: uri - type: *331 + type: *349 title: description: Title of the issue type: string @@ -153414,9 +155109,9 @@ webhooks: - active_lock_reason - body - reactions - label: *832 - organization: *808 - repository: *809 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -153496,8 +155191,8 @@ webhooks: type: string enum: - locked - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -154333,11 +156028,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154351,7 +156046,7 @@ webhooks: timeline_url: type: string format: uri - type: *331 + type: *349 title: description: Title of the issue type: string @@ -154434,8 +156129,8 @@ webhooks: format: uri user_view_type: type: string - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -154514,8 +156209,8 @@ webhooks: type: string enum: - milestoned - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155345,11 +157040,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155366,7 +157061,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -155446,9 +157141,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *838 - organization: *808 - repository: *809 + milestone: *856 + organization: *826 + repository: *827 sender: *4 required: - action @@ -156340,11 +158035,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156440,7 +158135,7 @@ webhooks: required: - login - id - type: *331 + type: *349 required: - id - number @@ -156921,8 +158616,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -157734,11 +159429,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157755,7 +159450,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -157857,8 +159552,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -157938,9 +159633,9 @@ webhooks: type: string enum: - pinned - enterprise: *806 - installation: *807 - issue: &839 + enterprise: *824 + installation: *825 + issue: &857 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -158746,11 +160441,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158767,7 +160462,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -158869,8 +160564,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -158949,8 +160644,8 @@ webhooks: type: string enum: - reopened - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -159784,11 +161479,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159885,9 +161580,9 @@ webhooks: format: uri user_view_type: type: string - type: *331 - organization: *808 - repository: *809 + type: *349 + organization: *826 + repository: *827 sender: *4 required: - action @@ -160776,11 +162471,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160797,7 +162492,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -161379,11 +163074,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *806 - installation: *807 - issue: *839 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *857 + organization: *826 + repository: *827 sender: *4 required: - action @@ -161463,12 +163158,12 @@ webhooks: type: string enum: - typed - enterprise: *806 - installation: *807 - issue: *840 - type: *331 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *858 + type: *349 + organization: *826 + repository: *827 sender: *4 required: - action @@ -161549,7 +163244,7 @@ webhooks: type: string enum: - unassigned - assignee: &864 + assignee: &882 title: User type: - object @@ -161621,11 +163316,11 @@ webhooks: required: - login - id - enterprise: *806 - installation: *807 - issue: *840 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *858 + organization: *826 + repository: *827 sender: *4 required: - action @@ -161704,12 +163399,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *806 - installation: *807 - issue: *840 - label: *832 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *858 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -161789,8 +163484,8 @@ webhooks: type: string enum: - unlocked - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -162624,11 +164319,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *751 - issue_dependencies_summary: *752 + sub_issues_summary: *770 + issue_dependencies_summary: *771 issue_field_values: type: array - items: *753 + items: *772 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162645,7 +164340,7 @@ webhooks: title: description: Title of the issue type: string - type: *331 + type: *349 updated_at: type: string format: date-time @@ -162725,8 +164420,8 @@ webhooks: format: uri user_view_type: type: string - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -162806,11 +164501,11 @@ webhooks: type: string enum: - unpinned - enterprise: *806 - installation: *807 - issue: *839 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *857 + organization: *826 + repository: *827 sender: *4 required: - action @@ -162889,12 +164584,12 @@ webhooks: type: string enum: - untyped - enterprise: *806 - installation: *807 - issue: *840 - type: *331 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + issue: *858 + type: *349 + organization: *826 + repository: *827 sender: *4 required: - action @@ -162974,11 +164669,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - label: *832 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -163056,11 +164751,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - label: *832 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -163170,11 +164865,11 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - label: *832 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + label: *850 + organization: *826 + repository: *827 sender: *4 required: - action @@ -163256,9 +164951,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *806 - installation: *807 - marketplace_purchase: &841 + enterprise: *824 + installation: *825 + marketplace_purchase: &859 title: Marketplace Purchase type: object required: @@ -163346,8 +165041,8 @@ webhooks: type: integer unit_count: type: integer - organization: *808 - previous_marketplace_purchase: &842 + organization: *826 + previous_marketplace_purchase: &860 title: Marketplace Purchase type: object properties: @@ -163431,7 +165126,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *809 + repository: *827 sender: *4 required: - action @@ -163511,10 +165206,10 @@ webhooks: - changed effective_date: type: string - enterprise: *806 - installation: *807 - marketplace_purchase: *841 - organization: *808 + enterprise: *824 + installation: *825 + marketplace_purchase: *859 + organization: *826 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -163602,7 +165297,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *809 + repository: *827 sender: *4 required: - action @@ -163684,10 +165379,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *806 - installation: *807 - marketplace_purchase: *841 - organization: *808 + enterprise: *824 + installation: *825 + marketplace_purchase: *859 + organization: *826 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -163773,7 +165468,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *809 + repository: *827 sender: *4 required: - action @@ -163854,8 +165549,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 marketplace_purchase: title: Marketplace Purchase type: object @@ -163941,9 +165636,9 @@ webhooks: type: integer unit_count: type: integer - organization: *808 - previous_marketplace_purchase: *842 - repository: *809 + organization: *826 + previous_marketplace_purchase: *860 + repository: *827 sender: *4 required: - action @@ -164023,12 +165718,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *806 - installation: *807 - marketplace_purchase: *841 - organization: *808 - previous_marketplace_purchase: *842 - repository: *809 + enterprise: *824 + installation: *825 + marketplace_purchase: *859 + organization: *826 + previous_marketplace_purchase: *860 + repository: *827 sender: *4 required: - action @@ -164130,11 +165825,11 @@ webhooks: type: string required: - to - enterprise: *806 - installation: *807 - member: *833 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + member: *851 + organization: *826 + repository: *827 sender: *4 required: - action @@ -164236,11 +165931,11 @@ webhooks: type: - string - 'null' - enterprise: *806 - installation: *807 - member: *833 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + member: *851 + organization: *826 + repository: *827 sender: *4 required: - action @@ -164319,11 +166014,11 @@ webhooks: type: string enum: - removed - enterprise: *806 - installation: *807 - member: *833 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + member: *851 + organization: *826 + repository: *827 sender: *4 required: - action @@ -164401,11 +166096,11 @@ webhooks: type: string enum: - added - enterprise: *806 - installation: *807 - member: *833 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + member: *851 + organization: *826 + repository: *827 scope: description: The scope of the membership. Currently, can only be `team`. @@ -164483,7 +166178,7 @@ webhooks: required: - login - id - team: &843 + team: &861 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -164713,11 +166408,11 @@ webhooks: type: string enum: - removed - enterprise: *806 - installation: *807 - member: *833 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + member: *851 + organization: *826 + repository: *827 scope: description: The scope of the membership. Currently, can only be `team`. @@ -164796,7 +166491,7 @@ webhooks: required: - login - id - team: *843 + team: *861 required: - action - scope @@ -164878,8 +166573,8 @@ webhooks: type: string enum: - checks_requested - installation: *807 - merge_group: &844 + installation: *825 + merge_group: &862 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -164898,15 +166593,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *503 + head_commit: *520 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -164992,10 +166687,10 @@ webhooks: - merged - invalidated - dequeued - installation: *807 - merge_group: *844 - organization: *808 - repository: *809 + installation: *825 + merge_group: *862 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165068,7 +166763,7 @@ webhooks: type: string enum: - deleted - enterprise: *806 + enterprise: *824 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -165177,12 +166872,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *807 - organization: *808 + installation: *825 + organization: *826 repository: anyOf: - type: 'null' - - *809 + - *827 sender: *4 required: - action @@ -165262,11 +166957,11 @@ webhooks: type: string enum: - closed - enterprise: *806 - installation: *807 - milestone: *838 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + milestone: *856 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165345,9 +167040,9 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - milestone: &845 + enterprise: *824 + installation: *825 + milestone: &863 title: Milestone description: A collection of related issues and pull requests. type: object @@ -165489,8 +167184,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165569,11 +167264,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - milestone: *838 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + milestone: *856 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165683,11 +167378,11 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - milestone: *838 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + milestone: *856 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165767,11 +167462,11 @@ webhooks: type: string enum: - opened - enterprise: *806 - installation: *807 - milestone: *845 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + milestone: *863 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165850,11 +167545,11 @@ webhooks: type: string enum: - blocked - blocked_user: *833 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + blocked_user: *851 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165933,11 +167628,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *833 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + blocked_user: *851 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -165956,6 +167651,320 @@ 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: *135 + enterprise: *824 + 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: *824 + installation: *825 + 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: *135 + enterprise: *824 + installation: *825 + 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: *824 + installation: *825 + organization: *826 + sender: *4 + new_property_values: + type: array + description: The new custom property values. + items: *140 + old_property_values: + type: array + description: The old custom property values. + items: *140 + 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: |- @@ -166016,9 +168025,9 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - membership: &846 + enterprise: *824 + installation: *825 + membership: &864 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -166128,8 +168137,8 @@ webhooks: - role - organization_url - user - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 required: - action @@ -166207,11 +168216,11 @@ webhooks: type: string enum: - member_added - enterprise: *806 - installation: *807 - membership: *846 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + membership: *864 + organization: *826 + repository: *827 sender: *4 required: - action @@ -166290,8 +168299,8 @@ webhooks: type: string enum: - member_invited - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -166413,10 +168422,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 - user: *833 + user: *851 required: - action - invitation @@ -166494,11 +168503,11 @@ webhooks: type: string enum: - member_removed - enterprise: *806 - installation: *807 - membership: *846 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + membership: *864 + organization: *826 + repository: *827 sender: *4 required: - action @@ -166585,11 +168594,11 @@ webhooks: properties: from: type: string - enterprise: *806 - installation: *807 - membership: *846 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + membership: *864 + organization: *826 + repository: *827 sender: *4 required: - action @@ -166665,9 +168674,9 @@ webhooks: type: string enum: - published - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 package: description: Information about the package. type: object @@ -167190,7 +169199,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &847 + items: &865 title: Ruby Gems metadata type: object properties: @@ -167287,7 +169296,7 @@ webhooks: - owner - package_version - registry - repository: *809 + repository: *827 sender: *4 required: - action @@ -167363,9 +169372,9 @@ webhooks: type: string enum: - updated - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 package: description: Information about the package. type: object @@ -167727,7 +169736,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *847 + items: *865 source_url: type: string format: uri @@ -167798,7 +169807,7 @@ webhooks: - owner - package_version - registry - repository: *809 + repository: *827 sender: *4 required: - action @@ -167979,12 +169988,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *806 + enterprise: *824 id: type: integer - installation: *807 - organization: *808 - repository: *809 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - id @@ -168061,7 +170070,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &848 + personal_access_token_request: &866 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -168211,10 +170220,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *806 - organization: *808 + enterprise: *824 + organization: *826 sender: *4 - installation: *807 + installation: *825 required: - action - personal_access_token_request @@ -168291,11 +170300,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *848 - enterprise: *806 - organization: *808 + personal_access_token_request: *866 + enterprise: *824 + organization: *826 sender: *4 - installation: *807 + installation: *825 required: - action - personal_access_token_request @@ -168371,11 +170380,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *848 - enterprise: *806 - organization: *808 + personal_access_token_request: *866 + enterprise: *824 + organization: *826 sender: *4 - installation: *807 + installation: *825 required: - action - personal_access_token_request @@ -168450,11 +170459,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *848 - organization: *808 - enterprise: *806 + personal_access_token_request: *866 + organization: *826 + enterprise: *824 sender: *4 - installation: *807 + installation: *825 required: - action - personal_access_token_request @@ -168559,7 +170568,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *849 + last_response: *867 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -168591,8 +170600,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 zen: description: Random string of GitHub zen. @@ -168837,10 +170846,10 @@ webhooks: - from required: - note - enterprise: *806 - installation: *807 - organization: *808 - project_card: &850 + enterprise: *824 + installation: *825 + organization: *826 + project_card: &868 title: Project Card type: object properties: @@ -168963,7 +170972,7 @@ webhooks: - creator - created_at - updated_at - repository: *809 + repository: *827 sender: *4 required: - action @@ -169044,11 +171053,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - project_card: *850 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project_card: *868 + repository: *827 sender: *4 required: - action @@ -169128,9 +171137,9 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 project_card: title: Project Card type: object @@ -169260,7 +171269,7 @@ webhooks: repository: anyOf: - type: 'null' - - *809 + - *827 sender: *4 required: - action @@ -169354,11 +171363,11 @@ webhooks: - from required: - note - enterprise: *806 - installation: *807 - organization: *808 - project_card: *850 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project_card: *868 + repository: *827 sender: *4 required: - action @@ -169452,9 +171461,9 @@ webhooks: - from required: - column_id - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 project_card: allOf: - title: Project Card @@ -169651,7 +171660,7 @@ webhooks: type: string required: - after_id - repository: *809 + repository: *827 sender: *4 required: - action @@ -169731,10 +171740,10 @@ webhooks: type: string enum: - closed - enterprise: *806 - installation: *807 - organization: *808 - project: &852 + enterprise: *824 + installation: *825 + organization: *826 + project: &870 title: Project type: object properties: @@ -169861,7 +171870,7 @@ webhooks: - creator - created_at - updated_at - repository: *809 + repository: *827 sender: *4 required: - action @@ -169941,10 +171950,10 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - project_column: &851 + enterprise: *824 + installation: *825 + organization: *826 + project_column: &869 title: Project Column type: object properties: @@ -169984,7 +171993,7 @@ webhooks: - name - created_at - updated_at - repository: *809 + repository: *827 sender: *4 required: - action @@ -170063,14 +172072,14 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - project_column: *851 + enterprise: *824 + installation: *825 + organization: *826 + project_column: *869 repository: anyOf: - type: 'null' - - *809 + - *827 sender: *4 required: - action @@ -170159,11 +172168,11 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - organization: *808 - project_column: *851 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project_column: *869 + repository: *827 sender: *4 required: - action @@ -170243,11 +172252,11 @@ webhooks: type: string enum: - moved - enterprise: *806 - installation: *807 - organization: *808 - project_column: *851 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project_column: *869 + repository: *827 sender: *4 required: - action @@ -170327,11 +172336,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - project: *852 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project: *870 + repository: *827 sender: *4 required: - action @@ -170411,14 +172420,14 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - project: *852 + enterprise: *824 + installation: *825 + organization: *826 + project: *870 repository: anyOf: - type: 'null' - - *809 + - *827 sender: *4 required: - action @@ -170519,11 +172528,11 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - organization: *808 - project: *852 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project: *870 + repository: *827 sender: *4 required: - action @@ -170602,11 +172611,11 @@ webhooks: type: string enum: - reopened - enterprise: *806 - installation: *807 - organization: *808 - project: *852 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + project: *870 + repository: *827 sender: *4 required: - action @@ -170687,9 +172696,9 @@ webhooks: type: string enum: - closed - installation: *807 - organization: *808 - projects_v2: *363 + installation: *825 + organization: *826 + projects_v2: *381 sender: *4 required: - action @@ -170770,9 +172779,9 @@ webhooks: type: string enum: - created - installation: *807 - organization: *808 - projects_v2: *363 + installation: *825 + organization: *826 + projects_v2: *381 sender: *4 required: - action @@ -170853,9 +172862,9 @@ webhooks: type: string enum: - deleted - installation: *807 - organization: *808 - projects_v2: *363 + installation: *825 + organization: *826 + projects_v2: *381 sender: *4 required: - action @@ -170976,9 +172985,9 @@ webhooks: type: string to: type: string - installation: *807 - organization: *808 - projects_v2: *363 + installation: *825 + organization: *826 + projects_v2: *381 sender: *4 required: - action @@ -171061,7 +173070,7 @@ webhooks: type: string enum: - archived - changes: &856 + changes: &874 type: object properties: archived_at: @@ -171077,9 +173086,9 @@ webhooks: - string - 'null' format: date-time - installation: *807 - organization: *808 - projects_v2_item: &853 + installation: *825 + organization: *826 + projects_v2_item: &871 title: Projects v2 Item description: An item belonging to a project type: object @@ -171097,7 +173106,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *370 + content_type: *388 creator: *4 created_at: type: string @@ -171219,9 +173228,9 @@ webhooks: - 'null' to: type: string - installation: *807 - organization: *808 - projects_v2_item: *853 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171303,9 +173312,9 @@ webhooks: type: string enum: - created - installation: *807 - organization: *808 - projects_v2_item: *853 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171386,9 +173395,9 @@ webhooks: type: string enum: - deleted - installation: *807 - organization: *808 - projects_v2_item: *853 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171493,7 +173502,7 @@ webhooks: oneOf: - type: string - type: integer - - &854 + - &872 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -171517,7 +173526,7 @@ webhooks: required: - id - name - - &855 + - &873 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -171557,8 +173566,8 @@ webhooks: oneOf: - type: string - type: integer - - *854 - - *855 + - *872 + - *873 type: - 'null' - string @@ -171581,9 +173590,9 @@ webhooks: - 'null' required: - body - installation: *807 - organization: *808 - projects_v2_item: *853 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171680,9 +173689,9 @@ webhooks: type: - string - 'null' - installation: *807 - organization: *808 - projects_v2_item: *853 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171765,10 +173774,10 @@ webhooks: type: string enum: - restored - changes: *856 - installation: *807 - organization: *808 - projects_v2_item: *853 + changes: *874 + installation: *825 + organization: *826 + projects_v2_item: *871 sender: *4 required: - action @@ -171850,9 +173859,9 @@ webhooks: type: string enum: - reopened - installation: *807 - organization: *808 - projects_v2: *363 + installation: *825 + organization: *826 + projects_v2: *381 sender: *4 required: - action @@ -171933,9 +173942,9 @@ webhooks: type: string enum: - created - installation: *807 - organization: *808 - projects_v2_status_update: *857 + installation: *825 + organization: *826 + projects_v2_status_update: *875 sender: *4 required: - action @@ -172016,9 +174025,9 @@ webhooks: type: string enum: - deleted - installation: *807 - organization: *808 - projects_v2_status_update: *857 + installation: *825 + organization: *826 + projects_v2_status_update: *875 sender: *4 required: - action @@ -172164,9 +174173,9 @@ webhooks: - string - 'null' format: date - installation: *807 - organization: *808 - projects_v2_status_update: *857 + installation: *825 + organization: *826 + projects_v2_status_update: *875 sender: *4 required: - action @@ -172237,10 +174246,10 @@ webhooks: title: public event type: object properties: - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - repository @@ -172317,13 +174326,13 @@ webhooks: type: string enum: - assigned - assignee: *833 - enterprise: *806 - installation: *807 - number: &858 + assignee: *851 + enterprise: *824 + installation: *825 + number: &876 description: The pull request number. type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -174672,7 +176681,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -174754,11 +176763,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -177100,7 +179109,7 @@ webhooks: - draft reason: type: string - repository: *809 + repository: *827 sender: *4 required: - action @@ -177182,11 +179191,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -179528,7 +181537,7 @@ webhooks: - draft reason: type: string - repository: *809 + repository: *827 sender: *4 required: - action @@ -179610,13 +181619,13 @@ webhooks: type: string enum: - closed - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: &859 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: &877 allOf: - - *658 + - *677 - type: object properties: allow_auto_merge: @@ -179678,7 +181687,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *809 + repository: *827 sender: *4 required: - action @@ -179759,12 +181768,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: *859 - repository: *809 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: *877 + repository: *827 sender: *4 required: - action @@ -179844,11 +181853,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *806 - milestone: *368 - number: *858 - organization: *808 - pull_request: &860 + enterprise: *824 + milestone: *386 + number: *876 + organization: *826 + pull_request: &878 title: Pull Request type: object properties: @@ -182175,7 +184184,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -182254,11 +184263,11 @@ webhooks: type: string enum: - dequeued - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -184604,7 +186613,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *809 + repository: *827 sender: *4 required: - action @@ -184728,12 +186737,12 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: *859 - repository: *809 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: *877 + repository: *827 sender: *4 required: - action @@ -184813,11 +186822,11 @@ webhooks: type: string enum: - enqueued - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -187148,7 +189157,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -187228,11 +189237,11 @@ webhooks: type: string enum: - labeled - enterprise: *806 - installation: *807 - label: *832 - number: *858 - organization: *808 + enterprise: *824 + installation: *825 + label: *850 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -189580,7 +191589,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -189661,10 +191670,10 @@ webhooks: type: string enum: - locked - enterprise: *806 - installation: *807 - number: *858 - organization: *808 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -192010,7 +194019,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -192090,12 +194099,12 @@ webhooks: type: string enum: - milestoned - enterprise: *806 - milestone: *368 - number: *858 - organization: *808 - pull_request: *860 - repository: *809 + enterprise: *824 + milestone: *386 + number: *876 + organization: *826 + pull_request: *878 + repository: *827 sender: *4 required: - action @@ -192174,12 +194183,12 @@ webhooks: type: string enum: - opened - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: *859 - repository: *809 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: *877 + repository: *827 sender: *4 required: - action @@ -192260,12 +194269,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: *859 - repository: *809 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: *877 + repository: *827 sender: *4 required: - action @@ -192345,12 +194354,12 @@ webhooks: type: string enum: - reopened - enterprise: *806 - installation: *807 - number: *858 - organization: *808 - pull_request: *859 - repository: *809 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 + pull_request: *877 + repository: *827 sender: *4 required: - action @@ -192725,9 +194734,9 @@ webhooks: - start_side - side - reactions - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: type: object properties: @@ -194957,7 +196966,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *809 + repository: *827 sender: *4 required: - action @@ -195037,7 +197046,7 @@ webhooks: type: string enum: - deleted - comment: &862 + comment: &880 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. @@ -195330,9 +197339,9 @@ webhooks: - start_side - side - reactions - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: type: object properties: @@ -197550,7 +199559,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *809 + repository: *827 sender: *4 required: - action @@ -197630,11 +199639,11 @@ webhooks: type: string enum: - edited - changes: *861 - comment: *862 - enterprise: *806 - installation: *807 - organization: *808 + changes: *879 + comment: *880 + enterprise: *824 + installation: *825 + organization: *826 pull_request: type: object properties: @@ -199855,7 +201864,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *809 + repository: *827 sender: *4 required: - action @@ -199936,9 +201945,9 @@ webhooks: type: string enum: - dismissed - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: title: Simple Pull Request type: object @@ -202171,7 +204180,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *809 + repository: *827 review: description: The review that was affected. type: object @@ -202422,9 +204431,9 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: title: Simple Pull Request type: object @@ -204538,8 +206547,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *809 - review: &863 + repository: *827 + review: &881 description: The review that was affected. type: object properties: @@ -204777,12 +206786,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: description: The pull request number. type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -207129,7 +209138,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 requested_reviewer: title: User type: @@ -207215,12 +209224,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: description: The pull request number. type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -209574,7 +211583,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 requested_team: title: Team description: Groups of organization members that gives permissions @@ -209769,12 +211778,12 @@ webhooks: type: string enum: - review_requested - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: description: The pull request number. type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -212123,7 +214132,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 requested_reviewer: title: User type: @@ -212210,12 +214219,12 @@ webhooks: type: string enum: - review_requested - enterprise: *806 - installation: *807 + enterprise: *824 + installation: *825 number: description: The pull request number. type: integer - organization: *808 + organization: *826 pull_request: title: Pull Request type: object @@ -214555,7 +216564,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 requested_team: title: Team description: Groups of organization members that gives permissions @@ -214739,9 +216748,9 @@ webhooks: type: string enum: - submitted - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: title: Simple Pull Request type: object @@ -216977,8 +218986,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *809 - review: *863 + repository: *827 + review: *881 sender: *4 required: - action @@ -217058,9 +219067,9 @@ webhooks: type: string enum: - resolved - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: title: Simple Pull Request type: object @@ -219191,7 +221200,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *809 + repository: *827 sender: *4 thread: type: object @@ -219588,9 +221597,9 @@ webhooks: type: string enum: - unresolved - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 pull_request: title: Simple Pull Request type: object @@ -221704,7 +223713,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *809 + repository: *827 sender: *4 thread: type: object @@ -222103,10 +224112,10 @@ webhooks: type: string before: type: string - enterprise: *806 - installation: *807 - number: *858 - organization: *808 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -224441,7 +226450,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -224523,11 +226532,11 @@ webhooks: type: string enum: - unassigned - assignee: *864 - enterprise: *806 - installation: *807 - number: *858 - organization: *808 + assignee: *882 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -226877,7 +228886,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -226956,11 +228965,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *806 - installation: *807 - label: *832 - number: *858 - organization: *808 + enterprise: *824 + installation: *825 + label: *850 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -229299,7 +231308,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -229380,10 +231389,10 @@ webhooks: type: string enum: - unlocked - enterprise: *806 - installation: *807 - number: *858 - organization: *808 + enterprise: *824 + installation: *825 + number: *876 + organization: *826 pull_request: title: Pull Request type: object @@ -231712,7 +233721,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *809 + repository: *827 sender: *4 required: - action @@ -231915,7 +233924,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *806 + enterprise: *824 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -232010,8 +234019,8 @@ webhooks: - url - author - committer - installation: *807 - organization: *808 + installation: *825 + organization: *826 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -232599,9 +234608,9 @@ webhooks: type: string enum: - published - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 registry_package: type: object properties: @@ -233078,7 +235087,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *847 + items: *865 summary: type: string tag_name: @@ -233134,7 +235143,7 @@ webhooks: - owner - package_version - registry - repository: *809 + repository: *827 sender: *4 required: - action @@ -233212,9 +235221,9 @@ webhooks: type: string enum: - updated - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 registry_package: type: object properties: @@ -233526,7 +235535,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *847 + items: *865 summary: type: string tag_name: @@ -233576,7 +235585,7 @@ webhooks: - owner - package_version - registry - repository: *809 + repository: *827 sender: *4 required: - action @@ -233653,10 +235662,10 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - release: &865 + enterprise: *824 + installation: *825 + organization: *826 + release: &883 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -233987,7 +235996,7 @@ webhooks: - updated_at - zipball_url - body - repository: *809 + repository: *827 sender: *4 required: - action @@ -234064,11 +236073,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - release: *865 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + release: *883 + repository: *827 sender: *4 required: - action @@ -234185,11 +236194,11 @@ webhooks: type: boolean required: - to - enterprise: *806 - installation: *807 - organization: *808 - release: *865 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + release: *883 + repository: *827 sender: *4 required: - action @@ -234267,9 +236276,9 @@ webhooks: type: string enum: - prereleased - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -234605,7 +236614,7 @@ webhooks: - string - 'null' format: uri - repository: *809 + repository: *827 sender: *4 required: - action @@ -234681,10 +236690,10 @@ webhooks: type: string enum: - published - enterprise: *806 - installation: *807 - organization: *808 - release: &866 + enterprise: *824 + installation: *825 + organization: *826 + release: &884 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -235017,7 +237026,7 @@ webhooks: - string - 'null' format: uri - repository: *809 + repository: *827 sender: *4 required: - action @@ -235093,11 +237102,11 @@ webhooks: type: string enum: - released - enterprise: *806 - installation: *807 - organization: *808 - release: *865 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + release: *883 + repository: *827 sender: *4 required: - action @@ -235173,11 +237182,11 @@ webhooks: type: string enum: - unpublished - enterprise: *806 - installation: *807 - organization: *808 - release: *866 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + release: *884 + repository: *827 sender: *4 required: - action @@ -235253,11 +237262,11 @@ webhooks: type: string enum: - published - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - repository_advisory: *711 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + repository_advisory: *730 sender: *4 required: - action @@ -235333,11 +237342,11 @@ webhooks: type: string enum: - reported - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - repository_advisory: *711 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + repository_advisory: *730 sender: *4 required: - action @@ -235413,10 +237422,10 @@ webhooks: type: string enum: - archived - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -235493,10 +237502,10 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -235574,10 +237583,10 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -235662,10 +237671,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -235780,10 +237789,10 @@ webhooks: - 'null' items: type: string - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -235855,10 +237864,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 status: type: string @@ -235939,10 +237948,10 @@ webhooks: type: string enum: - privatized - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -236019,10 +238028,10 @@ webhooks: type: string enum: - publicized - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -236116,10 +238125,10 @@ webhooks: - name required: - repository - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -236199,11 +238208,11 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - repository_ruleset: *158 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + repository_ruleset: *174 sender: *4 required: - action @@ -236281,11 +238290,11 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - repository_ruleset: *158 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + repository_ruleset: *174 sender: *4 required: - action @@ -236363,11 +238372,11 @@ webhooks: type: string enum: - edited - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - repository_ruleset: *158 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + repository_ruleset: *174 changes: type: object properties: @@ -236386,16 +238395,16 @@ webhooks: properties: added: type: array - items: *132 + items: *146 deleted: type: array - items: *132 + items: *146 updated: type: array items: type: object properties: - condition: *132 + condition: *146 changes: type: object properties: @@ -236428,16 +238437,16 @@ webhooks: properties: added: type: array - items: *679 + items: *698 deleted: type: array - items: *679 + items: *698 updated: type: array items: type: object properties: - rule: *679 + rule: *698 changes: type: object properties: @@ -236674,10 +238683,10 @@ webhooks: - from required: - owner - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -236755,10 +238764,10 @@ webhooks: type: string enum: - unarchived - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -236836,7 +238845,7 @@ webhooks: type: string enum: - create - alert: &867 + alert: &885 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -236960,10 +238969,10 @@ webhooks: type: string enum: - open - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -237173,10 +239182,10 @@ webhooks: type: string enum: - dismissed - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -237254,11 +239263,11 @@ webhooks: type: string enum: - reopen - alert: *867 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + alert: *885 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -237460,10 +239469,10 @@ webhooks: enum: - fixed - open - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -237541,17 +239550,17 @@ webhooks: type: string enum: - created - alert: &868 + alert: &886 type: object properties: - number: *109 - created_at: *116 + number: *119 + created_at: *126 updated_at: anyOf: - type: 'null' - - *117 - url: *114 - html_url: *115 + - *127 + url: *124 + html_url: *125 locations_url: type: string format: uri @@ -237655,10 +239664,10 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -237739,11 +239748,11 @@ webhooks: type: string enum: - created - alert: *868 - installation: *807 - location: *869 - organization: *808 - repository: *809 + alert: *886 + installation: *825 + location: *887 + organization: *826 + repository: *827 sender: *4 required: - location @@ -237981,11 +239990,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *868 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + alert: *886 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -238063,11 +240072,11 @@ webhooks: type: string enum: - reopened - alert: *868 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + alert: *886 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -238145,11 +240154,11 @@ webhooks: type: string enum: - resolved - alert: *868 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + alert: *886 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -238227,11 +240236,11 @@ webhooks: type: string enum: - validated - alert: *868 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + alert: *886 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -238361,10 +240370,10 @@ webhooks: - organization - enterprise - - repository: *809 - enterprise: *806 - installation: *807 - organization: *808 + repository: *827 + enterprise: *824 + installation: *825 + organization: *826 sender: *4 required: - action @@ -238442,11 +240451,11 @@ webhooks: type: string enum: - published - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - security_advisory: &870 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + security_advisory: &888 description: The details of the security advisory, including summary, description, and severity. type: object @@ -238463,7 +240472,7 @@ webhooks: required: - vector_string - score - cvss_severities: *111 + cvss_severities: *121 cwes: type: array items: @@ -238632,11 +240641,11 @@ webhooks: type: string enum: - updated - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 - security_advisory: *870 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 + security_advisory: *888 sender: *4 required: - action @@ -238709,10 +240718,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -238730,7 +240739,7 @@ webhooks: required: - vector_string - score - cvss_severities: *111 + cvss_severities: *121 cwes: type: array items: @@ -238898,11 +240907,11 @@ webhooks: from: type: object properties: - security_and_analysis: *377 - enterprise: *806 - installation: *807 - organization: *808 - repository: *443 + security_and_analysis: *394 + enterprise: *824 + installation: *825 + organization: *826 + repository: *460 sender: *4 required: - changes @@ -238980,12 +240989,12 @@ webhooks: type: string enum: - cancelled - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: &871 + sponsorship: &889 type: object properties: created_at: @@ -239290,12 +241299,12 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: *871 + sponsorship: *889 required: - action - sponsorship @@ -239383,12 +241392,12 @@ webhooks: type: string required: - from - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: *871 + sponsorship: *889 required: - action - changes @@ -239465,17 +241474,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &872 + effective_date: &890 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: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: *871 + sponsorship: *889 required: - action - sponsorship @@ -239549,7 +241558,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &873 + changes: &891 type: object properties: tier: @@ -239593,13 +241602,13 @@ webhooks: - from required: - tier - effective_date: *872 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + effective_date: *890 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: *871 + sponsorship: *889 required: - action - changes @@ -239676,13 +241685,13 @@ webhooks: type: string enum: - tier_changed - changes: *873 - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + changes: *891 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - sponsorship: *871 + sponsorship: *889 required: - action - changes @@ -239756,10 +241765,10 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -239843,10 +241852,10 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -240280,15 +242289,15 @@ webhooks: type: - string - 'null' - enterprise: *806 + enterprise: *824 id: description: The unique identifier of the status. type: integer - installation: *807 + installation: *825 name: type: string - organization: *808 - repository: *809 + organization: *826 + repository: *827 sender: *4 sha: description: The Commit SHA. @@ -240398,15 +242407,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *183 - parent_issue_repo: *67 + parent_issue: *200 + parent_issue_repo: *72 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *183 - installation: *807 - organization: *808 - repository: *809 + sub_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -240490,15 +242499,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *183 - parent_issue_repo: *67 + parent_issue: *200 + parent_issue_repo: *72 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *183 - installation: *807 - organization: *808 - repository: *809 + sub_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -240582,15 +242591,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *183 - sub_issue_repo: *67 + sub_issue: *200 + sub_issue_repo: *72 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *183 - installation: *807 - organization: *808 - repository: *809 + parent_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -240674,15 +242683,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *183 - sub_issue_repo: *67 + sub_issue: *200 + sub_issue_repo: *72 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *183 - installation: *807 - organization: *808 - repository: *809 + parent_issue: *200 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -240759,12 +242768,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - team: &874 + team: &892 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -240994,9 +243003,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 repository: title: Repository description: A git repository @@ -241466,7 +243475,7 @@ webhooks: - topics - visibility sender: *4 - team: *874 + team: *892 required: - action - team @@ -241542,9 +243551,9 @@ webhooks: type: string enum: - created - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 repository: title: Repository description: A git repository @@ -242014,7 +244023,7 @@ webhooks: - topics - visibility sender: *4 - team: *874 + team: *892 required: - action - team @@ -242091,9 +244100,9 @@ webhooks: type: string enum: - deleted - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 repository: title: Repository description: A git repository @@ -242563,7 +244572,7 @@ webhooks: - topics - visibility sender: *4 - team: *874 + team: *892 required: - action - team @@ -242707,9 +244716,9 @@ webhooks: - from required: - permissions - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 repository: title: Repository description: A git repository @@ -243179,7 +245188,7 @@ webhooks: - topics - visibility sender: *4 - team: *874 + team: *892 required: - action - changes @@ -243257,9 +245266,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *806 - installation: *807 - organization: *808 + enterprise: *824 + installation: *825 + organization: *826 repository: title: Repository description: A git repository @@ -243729,7 +245738,7 @@ webhooks: - topics - visibility sender: *4 - team: *874 + team: *892 required: - action - team @@ -243805,10 +245814,10 @@ webhooks: type: string enum: - started - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 required: - action @@ -243881,17 +245890,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *806 + enterprise: *824 inputs: type: - object - 'null' additionalProperties: true - installation: *807 - organization: *808 + installation: *825 + organization: *826 ref: type: string - repository: *809 + repository: *827 sender: *4 workflow: type: string @@ -243973,10 +245982,10 @@ webhooks: type: string enum: - completed - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 workflow_job: allOf: @@ -244232,7 +246241,7 @@ webhooks: type: string required: - conclusion - deployment: *569 + deployment: *586 required: - action - repository @@ -244311,10 +246320,10 @@ webhooks: type: string enum: - in_progress - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 workflow_job: allOf: @@ -244596,7 +246605,7 @@ webhooks: required: - status - steps - deployment: *569 + deployment: *586 required: - action - repository @@ -244675,10 +246684,10 @@ webhooks: type: string enum: - queued - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 workflow_job: type: object @@ -244824,7 +246833,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *569 + deployment: *586 required: - action - repository @@ -244903,10 +246912,10 @@ webhooks: type: string enum: - waiting - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 workflow_job: type: object @@ -245053,7 +247062,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *569 + deployment: *586 required: - action - repository @@ -245133,12 +247142,12 @@ webhooks: type: string enum: - completed - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - workflow: *828 + workflow: *846 workflow_run: title: Workflow Run type: object @@ -246157,12 +248166,12 @@ webhooks: type: string enum: - in_progress - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - workflow: *828 + workflow: *846 workflow_run: title: Workflow Run type: object @@ -247166,12 +249175,12 @@ webhooks: type: string enum: - requested - enterprise: *806 - installation: *807 - organization: *808 - repository: *809 + enterprise: *824 + installation: *825 + organization: *826 + repository: *827 sender: *4 - workflow: *828 + workflow: *846 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 13d5fb5fa..f1507aa50 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/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." @@ -2509,6 +2513,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -2529,6 +2540,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": [ @@ -2580,6 +2596,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", @@ -2946,6 +3237,13 @@ "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", + "null" + ] } } }, @@ -8689,6 +8987,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", @@ -8738,12 +9246,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -9284,6 +9786,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", @@ -10233,7 +11170,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "secret-scanning", "subcategory": "secret-scanning" @@ -10540,6 +11477,9 @@ "parameters": [ { "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/cost-center-state" } ], "responses": { @@ -11133,7 +12073,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" ], @@ -11501,6 +12441,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": { "type": [ "string", @@ -11902,6 +12852,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", @@ -12003,6 +13283,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": { "type": [ "string", @@ -15459,10 +16749,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" ], @@ -16119,6 +17524,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -16137,6 +17549,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": [ @@ -16189,17 +17606,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/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization" }, "parameters": [ { @@ -16224,14 +17641,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" } } } @@ -16246,17 +17663,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/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + "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", + "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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -16555,6 +18247,13 @@ "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", + "null" + ] } } }, @@ -21105,6 +22804,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", @@ -21785,7 +23555,10 @@ }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", - "type": "array", + "type": [ + "array", + "null" + ], "minItems": 1, "items": { "type": "object", @@ -21819,8 +23592,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -25584,12 +27368,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -32816,17 +34594,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } }, @@ -33004,17 +34786,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -55708,16 +57494,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).\"", @@ -55733,12 +57509,6 @@ }, { "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -73421,7 +75191,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" ], @@ -88970,17 +90740,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -89149,17 +90923,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -89708,7 +91486,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" ], @@ -102779,13 +104557,13 @@ } } }, - "organization-deleted": { + "organization-custom-property-created": { "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.", - "description": "An organization was deleted.", - "operationId": "organization/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#organization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -102850,7 +104628,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-organization-custom-property-created" } } } @@ -102861,24 +104639,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "organization", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "organization", - "business", - "app" + "business" ] } } }, - "organization-member-added": { + "organization-custom-property-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.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "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" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -102943,7 +104719,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-organization-custom-property-deleted" } } } @@ -102954,24 +104730,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "organization", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "organization", - "business", - "app" + "business" ] } } }, - "organization-member-invited": { + "organization-custom-property-updated": { "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.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "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" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -103036,7 +104810,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-organization-custom-property-updated" } } } @@ -103047,24 +104821,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "organization", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "organization", - "business", - "app" + "business" ] } } }, - "organization-member-removed": { + "organization-custom-property-values-updated": { "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.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "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" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values" }, "parameters": [ { @@ -103129,7 +104901,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-organization-custom-property-values-updated" } } } @@ -103140,22 +104912,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "organization", + "subcategory": "organization-custom-property-values", "supported-webhook-types": [ - "organization", "business", + "organization", "app" ] } } }, - "organization-renamed": { + "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.", - "description": "The name of an organization was changed.", - "operationId": "organization/renamed", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, @@ -103222,7 +104994,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -103244,13 +105016,13 @@ } } }, - "package-published": { + "organization-member-added": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "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.", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -103315,7 +105087,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -103328,22 +105100,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "package-updated": { + "organization-member-invited": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "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.", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -103408,7 +105180,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -103421,21 +105193,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "page-build": { + "organization-member-removed": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "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.", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -103500,7 +105273,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -103513,22 +105286,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page_build", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "personal-access-token-request-approved": { + "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was approved.", - "operationId": "personal-access-token-request/approved", + "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.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -103540,9 +105313,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -103550,31 +105323,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", + "example": "issues", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Id", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": 12312312, + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": 123123, + "example": "repository", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Delivery", "in": "header", - "example": "integration", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -103593,7 +105366,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -103606,21 +105379,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "organization", "supported-webhook-types": [ - "app", - "organization" + "organization", + "business", + "app" ] } } }, - "personal-access-token-request-cancelled": { + "package-published": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was cancelled by the requester.", - "operationId": "personal-access-token-request/cancelled", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -103632,9 +105406,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -103642,31 +105416,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", + "example": "issues", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Id", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": 12312312, + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": 123123, + "example": "repository", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Delivery", "in": "header", - "example": "integration", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -103685,7 +105459,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -103698,21 +105472,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "package", "supported-webhook-types": [ - "app", - "organization" + "repository", + "organization", + "app" ] } } }, - "personal-access-token-request-created": { + "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was created.", - "operationId": "personal-access-token-request/created", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -103723,6 +105498,38 @@ "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", @@ -103732,9 +105539,53 @@ } }, { - "name": "X-Github-Event", + "name": "X-Hub-Signature-256", "in": "header", - "example": "personal_access_token_request", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-package-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "package", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "page-build": { + "post": { + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" } @@ -103747,6 +105598,14 @@ "type": "string" } }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", @@ -103758,7 +105617,15 @@ { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "integration", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -103777,7 +105644,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -103790,19 +105657,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "page_build", "supported-webhook-types": [ - "app", - "organization" + "repository", + "organization", + "app" ] } } }, - "personal-access-token-request-denied": { + "personal-access-token-request-approved": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was denied.", - "operationId": "personal-access-token-request/denied", + "description": "A fine-grained personal access token request was approved.", + "operationId": "personal-access-token-request/approved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -103869,7 +105737,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" } } } @@ -103890,12 +105758,13 @@ } } }, - "ping": { + "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", - "operationId": "ping", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was cancelled by the requester.", + "operationId": "personal-access-token-request/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -103907,9 +105776,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -103917,31 +105786,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -103960,22 +105829,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-ping" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-ping-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping-form-encoded" - } + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -103987,26 +105841,22 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app", - "business", - "marketplace" + "organization" ] } } }, - "project-card-converted": { + "personal-access-token-request-created": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a project (classic) was converted to an issue.", - "operationId": "project-card/converted", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -104017,38 +105867,6 @@ "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", @@ -104058,54 +105876,9 @@ } }, { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-project-card-converted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "project_card", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "project-card-created": { - "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card was added to a project (classic).", - "operationId": "project-card/created", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" - }, - "parameters": [ - { - "name": "User-Agent", + "name": "X-Github-Event", "in": "header", - "example": "GitHub-Hookshot/123abc", + "example": "personal_access_token_request", "schema": { "type": "string" } @@ -104118,14 +105891,6 @@ "type": "string" } }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", @@ -104137,15 +105902,7 @@ { "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", + "example": "integration", "schema": { "type": "string" } @@ -104164,7 +105921,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } @@ -104177,22 +105934,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", - "app" + "app", + "organization" ] } } }, - "project-card-deleted": { + "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was deleted.", - "operationId": "project-card/deleted", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -104204,9 +105960,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -104214,31 +105970,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -104257,7 +106013,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -104270,22 +106026,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", - "app" + "app", + "organization" ] } } }, - "project-card-edited": { + "ping": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note on a project (classic) was edited.", - "operationId": "project-card/edited", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -104350,7 +106104,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-ping" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-ping-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping-form-encoded" + } } } } @@ -104362,21 +106131,24 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "ping", "supported-webhook-types": [ "repository", "organization", - "app" + "app", + "business", + "marketplace" ] } } }, - "project-card-moved": { + "project-card-converted": { "post": { "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was moved to another column or to another position in its column.", - "operationId": "project-card/moved", + "description": "A note in a project (classic) was converted to an issue.", + "operationId": "project-card/converted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, @@ -104443,7 +106215,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-project-card-converted" } } } @@ -104465,13 +106237,13 @@ } } }, - "project-closed": { + "project-card-created": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/closed", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card was added to a project (classic).", + "operationId": "project-card/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -104536,7 +106308,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-project-card-created" } } } @@ -104549,7 +106321,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -104558,13 +106330,13 @@ } } }, - "project-column-created": { + "project-card-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was added to a project (classic).", - "operationId": "project-column/created", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was deleted.", + "operationId": "project-card/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -104629,7 +106401,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-project-card-deleted" } } } @@ -104642,7 +106414,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -104651,13 +106423,13 @@ } } }, - "project-column-deleted": { + "project-card-edited": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was deleted from a project (classic).", - "operationId": "project-column/deleted", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note on a project (classic) was edited.", + "operationId": "project-card/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -104722,7 +106494,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-card-edited" } } } @@ -104735,7 +106507,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -104744,13 +106516,13 @@ } } }, - "project-column-edited": { + "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name of a column on a project (classic) was changed.", - "operationId": "project-column/edited", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was moved to another column or to another position in its column.", + "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -104815,7 +106587,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-card-moved" } } } @@ -104828,7 +106600,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -104837,13 +106609,13 @@ } } }, - "project-column-moved": { + "project-closed": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was moved to a new position on a project (classic).", - "operationId": "project-column/moved", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -104908,7 +106680,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-closed" } } } @@ -104921,7 +106693,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -104930,13 +106702,13 @@ } } }, - "project-created": { + "project-column-created": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was created.", - "operationId": "project/created", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was added to a project (classic).", + "operationId": "project-column/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -105001,7 +106773,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-column-created" } } } @@ -105014,7 +106786,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -105023,13 +106795,13 @@ } } }, - "project-deleted": { + "project-column-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was deleted.", - "operationId": "project/deleted", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was deleted from a project (classic).", + "operationId": "project-column/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -105094,7 +106866,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-column-deleted" } } } @@ -105107,7 +106879,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -105116,13 +106888,13 @@ } } }, - "project-edited": { + "project-column-edited": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name or description of a project (classic) was changed.", - "operationId": "project/edited", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name of a column on a project (classic) was changed.", + "operationId": "project-column/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -105187,7 +106959,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-project-column-edited" } } } @@ -105200,7 +106972,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -105209,13 +106981,13 @@ } } }, - "project-reopened": { + "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/reopened", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was moved to a new position on a project (classic).", + "operationId": "project-column/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -105280,7 +107052,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-project-column-moved" } } } @@ -105293,7 +107065,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -105302,13 +107074,13 @@ } } }, - "projects-v2-closed": { + "project-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was closed.", - "operationId": "projects-v2/closed", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was created.", + "operationId": "project/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -105330,7 +107102,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -105373,7 +107145,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-project-created" } } } @@ -105385,22 +107157,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-created": { + "project-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was created.", - "operationId": "projects-v2/created", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was deleted.", + "operationId": "project/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -105422,7 +107195,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -105465,7 +107238,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-project-deleted" } } } @@ -105477,22 +107250,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-deleted": { + "project-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was deleted.", - "operationId": "projects-v2/deleted", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name or description of a project (classic) was changed.", + "operationId": "project/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -105514,7 +107288,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -105557,7 +107331,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-project-edited" } } } @@ -105569,22 +107343,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-edited": { + "project-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The title, description, or README of a project in the organization was changed.", - "operationId": "projects-v2/edited", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -105606,7 +107381,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -105649,7 +107424,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-project-reopened" } } } @@ -105661,22 +107436,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-archived": { + "projects-v2-closed": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was closed.", + "operationId": "projects-v2/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -105698,7 +107474,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -105741,7 +107517,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" } } } @@ -105755,20 +107531,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-converted": { + "projects-v2-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A draft issue in an organization project was converted to an issue.", - "operationId": "projects-v2-item/converted", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was created.", + "operationId": "projects-v2/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -105790,7 +107566,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -105833,7 +107609,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" } } } @@ -105847,20 +107623,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-created": { + "projects-v2-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was added to a project in the organization.", - "operationId": "projects-v2-item/created", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was deleted.", + "operationId": "projects-v2/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -105882,7 +107658,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -105925,7 +107701,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" } } } @@ -105939,20 +107715,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-deleted": { + "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was deleted from a project in the organization.", - "operationId": "projects-v2-item/deleted", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The title, description, or README of a project in the organization was changed.", + "operationId": "projects-v2/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -105974,7 +107750,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -106017,7 +107793,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" } } } @@ -106031,18 +107807,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-edited": { + "projects-v2-item-archived": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", - "operationId": "projects-v2-item/edited", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/archived", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -106109,7 +107885,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" } } } @@ -106130,11 +107906,11 @@ } } }, - "projects-v2-item-reordered": { + "projects-v2-item-converted": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", - "operationId": "projects-v2-item/reordered", + "description": "A draft issue in an organization project was converted to an issue.", + "operationId": "projects-v2-item/converted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -106201,7 +107977,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" } } } @@ -106222,11 +107998,11 @@ } } }, - "projects-v2-item-restored": { + "projects-v2-item-created": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -106293,7 +108069,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" } } } @@ -106314,13 +108090,13 @@ } } }, - "projects-v2-reopened": { + "projects-v2-item-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was reopened.", - "operationId": "projects-v2/reopened", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -106342,7 +108118,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -106385,7 +108161,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" } } } @@ -106399,20 +108175,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-status-update-created": { + "projects-v2-item-edited": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was added to a project in the organization.", - "operationId": "projects-v2-status-update/created", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", + "operationId": "projects-v2-item/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -106434,7 +108210,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "project-v2-item", "schema": { "type": "string" } @@ -106477,7 +108253,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" } } } @@ -106491,20 +108267,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-status-update-deleted": { + "projects-v2-item-reordered": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was removed from a project in the organization.", - "operationId": "projects-v2-status-update/deleted", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", + "operationId": "projects-v2-item/reordered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -106526,7 +108302,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "project-v2-item", "schema": { "type": "string" } @@ -106569,7 +108345,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" } } } @@ -106583,20 +108359,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-status-update-edited": { + "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was edited on a project in the organization.", - "operationId": "projects-v2-status-update/edited", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/restored", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -106618,7 +108394,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "project-v2-item", "schema": { "type": "string" } @@ -106661,7 +108437,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" } } } @@ -106675,19 +108451,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "public": { + "projects-v2-reopened": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "operationId": "public", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was reopened.", + "operationId": "projects-v2/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -106709,7 +108486,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -106752,7 +108529,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" } } } @@ -106764,23 +108541,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "public", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-assigned": { + "projects-v2-status-update-created": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was assigned to a user.", - "operationId": "pull-request/assigned", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was added to a project in the organization.", + "operationId": "projects-v2-status-update/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -106802,7 +108578,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -106845,7 +108621,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" } } } @@ -106857,23 +108633,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-auto-merge-disabled": { + "projects-v2-status-update-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was removed from a project in the organization.", + "operationId": "projects-v2-status-update/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -106895,7 +108670,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -106938,7 +108713,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" } } } @@ -106950,23 +108725,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-auto-merge-enabled": { + "projects-v2-status-update-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was edited on a project in the organization.", + "operationId": "projects-v2-status-update/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -106988,7 +108762,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -107031,7 +108805,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" } } } @@ -107043,23 +108817,21 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-closed": { + "public": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", - "operationId": "pull-request/closed", + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -107124,7 +108896,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-public" } } } @@ -107137,7 +108909,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "public", "supported-webhook-types": [ "repository", "organization", @@ -107146,11 +108918,11 @@ } } }, - "pull-request-converted-to-draft": { + "pull-request-assigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/converted-to-draft", + "description": "A pull request was assigned to a user.", + "operationId": "pull-request/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107217,7 +108989,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-pull-request-assigned" } } } @@ -107239,11 +109011,11 @@ } } }, - "pull-request-demilestoned": { + "pull-request-auto-merge-disabled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from a milestone.", - "operationId": "pull-request/demilestoned", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-disabled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107310,7 +109082,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" } } } @@ -107332,11 +109104,11 @@ } } }, - "pull-request-dequeued": { + "pull-request-auto-merge-enabled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from the merge queue.", - "operationId": "pull-request/dequeued", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-enabled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107403,7 +109175,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" } } } @@ -107425,11 +109197,11 @@ } } }, - "pull-request-edited": { + "pull-request-closed": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", - "operationId": "pull-request/edited", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107496,7 +109268,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-closed" } } } @@ -107518,11 +109290,11 @@ } } }, - "pull-request-enqueued": { + "pull-request-converted-to-draft": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to the merge queue.", - "operationId": "pull-request/enqueued", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107589,7 +109361,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" } } } @@ -107611,11 +109383,11 @@ } } }, - "pull-request-labeled": { + "pull-request-demilestoned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was added to a pull request.", - "operationId": "pull-request/labeled", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107682,7 +109454,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" } } } @@ -107704,11 +109476,11 @@ } } }, - "pull-request-locked": { + "pull-request-dequeued": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/locked", + "description": "A pull request was removed from the merge queue.", + "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107775,7 +109547,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" } } } @@ -107797,11 +109569,11 @@ } } }, - "pull-request-milestoned": { + "pull-request-edited": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to a milestone.", - "operationId": "pull-request/milestoned", + "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", + "operationId": "pull-request/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107868,7 +109640,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-edited" } } } @@ -107890,11 +109662,11 @@ } } }, - "pull-request-opened": { + "pull-request-enqueued": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was created", - "operationId": "pull-request/opened", + "description": "A pull request was added to the merge queue.", + "operationId": "pull-request/enqueued", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107961,7 +109733,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" } } } @@ -107983,11 +109755,11 @@ } } }, - "pull-request-ready-for-review": { + "pull-request-labeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/ready-for-review", + "description": "A label was added to a pull request.", + "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -108054,7 +109826,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-labeled" } } } @@ -108076,11 +109848,11 @@ } } }, - "pull-request-reopened": { + "pull-request-locked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously closed pull request was reopened.", - "operationId": "pull-request/reopened", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -108147,7 +109919,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-locked" } } } @@ -108169,13 +109941,13 @@ } } }, - "pull-request-review-comment-created": { + "pull-request-milestoned": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was created.", - "operationId": "pull-request-review-comment/created", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a milestone.", + "operationId": "pull-request/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -108240,7 +110012,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" } } } @@ -108253,7 +110025,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -108262,13 +110034,13 @@ } } }, - "pull-request-review-comment-deleted": { + "pull-request-opened": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was deleted.", - "operationId": "pull-request-review-comment/deleted", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", + "operationId": "pull-request/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -108333,7 +110105,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-opened" } } } @@ -108346,7 +110118,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -108355,13 +110127,13 @@ } } }, - "pull-request-review-comment-edited": { + "pull-request-ready-for-review": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The content of a comment on a pull request diff was changed.", - "operationId": "pull-request-review-comment/edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/ready-for-review", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -108426,7 +110198,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" } } } @@ -108439,7 +110211,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -108448,13 +110220,13 @@ } } }, - "pull-request-review-dismissed": { + "pull-request-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was dismissed.", - "operationId": "pull-request-review/dismissed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", + "operationId": "pull-request/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -108519,7 +110291,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-reopened" } } } @@ -108532,7 +110304,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -108541,13 +110313,13 @@ } } }, - "pull-request-review-edited": { + "pull-request-review-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The body comment on a pull request review was edited.", - "operationId": "pull-request-review/edited", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", + "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -108612,7 +110384,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" } } } @@ -108625,7 +110397,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -108634,13 +110406,13 @@ } } }, - "pull-request-review-request-removed": { + "pull-request-review-comment-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A request for review by a person or team was removed from a pull request.", - "operationId": "pull-request/review-request-removed", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", + "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -108705,7 +110477,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" } } } @@ -108718,7 +110490,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -108727,13 +110499,13 @@ } } }, - "pull-request-review-requested": { + "pull-request-review-comment-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", - "operationId": "pull-request/review-requested", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", + "operationId": "pull-request-review-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -108798,7 +110570,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" } } } @@ -108811,7 +110583,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -108820,11 +110592,11 @@ } } }, - "pull-request-review-submitted": { + "pull-request-review-dismissed": { "post": { "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was submitted.", - "operationId": "pull-request-review/submitted", + "description": "A review on a pull request was dismissed.", + "operationId": "pull-request-review/dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" }, @@ -108891,7 +110663,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" } } } @@ -108913,106 +110685,13 @@ } } }, - "pull-request-review-thread-resolved": { - "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment thread on a pull request was marked as resolved.", - "operationId": "pull-request-review-thread/resolved", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" - }, - "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-pull-request-review-thread-resolved" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "pull_request_review_thread", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-review-thread-unresolved": { + "pull-request-review-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously resolved comment thread on a pull request was marked as unresolved.", - "operationId": "pull-request-review-thread/unresolved", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", + "operationId": "pull-request-review/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -109077,7 +110756,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" } } } @@ -109090,7 +110769,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -109099,11 +110778,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-review-request-removed": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A request for review by a person or team was removed from a pull request.", + "operationId": "pull-request/review-request-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109170,7 +110849,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" } } } @@ -109192,11 +110871,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-review-requested": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "operationId": "pull-request/review-requested", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109263,7 +110942,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" } } } @@ -109285,13 +110964,13 @@ } } }, - "pull-request-unlabeled": { + "pull-request-review-submitted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -109356,7 +111035,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" } } } @@ -109369,7 +111048,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -109378,11 +111057,197 @@ } } }, - "pull-request-unlocked": { + "pull-request-review-thread-resolved": { + "post": { + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", + "operationId": "pull-request-review-thread/resolved", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + }, + "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-pull-request-review-thread-resolved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review_thread", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-thread-unresolved": { + "post": { + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", + "operationId": "pull-request-review-thread/unresolved", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + }, + "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-pull-request-review-thread-unresolved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review_thread", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109449,7 +111314,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -109471,12 +111336,13 @@ } } }, - "push": { + "pull-request-unassigned": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -109541,7 +111407,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -109554,7 +111420,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -109563,13 +111429,13 @@ } } }, - "registry-package-published": { + "pull-request-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -109634,7 +111500,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -109647,7 +111513,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -109656,13 +111522,13 @@ } } }, - "registry-package-updated": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -109727,7 +111593,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -109740,7 +111606,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -109749,13 +111615,12 @@ } } }, - "release-created": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -109820,7 +111685,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-push" } } } @@ -109833,7 +111698,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -109842,13 +111707,13 @@ } } }, - "release-deleted": { + "registry-package-published": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -109913,7 +111778,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -109926,7 +111791,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -109935,11 +111800,104 @@ } } }, - "release-edited": { + "registry-package-updated": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + }, + "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-registry-package-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "registry_package", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-created": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -110006,7 +111964,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -110028,11 +111986,11 @@ } } }, - "release-prereleased": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -110099,7 +112057,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -110121,11 +112079,11 @@ } } }, - "release-published": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -110192,7 +112150,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -110214,11 +112172,11 @@ } } }, - "release-released": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -110285,7 +112243,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -110307,11 +112265,11 @@ } } }, - "release-unpublished": { + "release-published": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -110378,7 +112336,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -110400,13 +112358,13 @@ } } }, - "repository-advisory-published": { + "release-released": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -110471,7 +112429,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -110484,7 +112442,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -110493,13 +112451,13 @@ } } }, - "repository-advisory-reported": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A private vulnerability report was submitted.", - "operationId": "repository-advisory/reported", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -110564,7 +112522,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -110577,7 +112535,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -110586,13 +112544,13 @@ } } }, - "repository-archived": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was archived.", - "operationId": "repository/archived", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -110657,7 +112615,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -110670,9 +112628,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -110680,13 +112637,13 @@ } } }, - "repository-created": { + "repository-advisory-reported": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was created.", - "operationId": "repository/created", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -110751,7 +112708,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -110764,9 +112721,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -110774,11 +112730,11 @@ } } }, - "repository-deleted": { + "repository-archived": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", - "operationId": "repository/deleted", + "description": "A repository was archived.", + "operationId": "repository/archived", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -110845,7 +112801,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -110868,12 +112824,13 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-created": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -110938,7 +112895,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -110951,18 +112908,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "repository-deleted": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The topics, default branch, description, or homepage of a repository was changed.", - "operationId": "repository/edited", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -111029,7 +112989,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -111052,12 +113012,12 @@ } } }, - "repository-import": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports).", - "operationId": "repository-import", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -111122,7 +113082,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -111135,19 +113095,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "repository", - "organization" + "app" ] } } }, - "repository-privatized": { + "repository-edited": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -111214,7 +113173,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -111237,13 +113196,12 @@ } } }, - "repository-publicized": { + "repository-import": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -111308,7 +113266,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -111321,21 +113279,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_import", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-renamed": { + "repository-privatized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -111402,7 +113358,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -111425,13 +113381,13 @@ } } }, - "repository-ruleset-created": { + "repository-publicized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -111496,7 +113452,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -111509,8 +113465,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -111518,13 +113475,13 @@ } } }, - "repository-ruleset-deleted": { + "repository-renamed": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -111589,7 +113546,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -111602,8 +113559,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -111611,11 +113569,11 @@ } } }, - "repository-ruleset-edited": { + "repository-ruleset-created": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -111682,7 +113640,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -111704,13 +113662,13 @@ } } }, - "repository-transferred": { + "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -111775,7 +113733,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -111788,9 +113746,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -111798,13 +113755,13 @@ } } }, - "repository-unarchived": { + "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -111869,7 +113826,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -111882,9 +113839,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -111892,13 +113848,13 @@ } } }, - "repository-vulnerability-alert-create": { + "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -111963,7 +113919,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -111976,21 +113932,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-dismiss": { + "repository-unarchived": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -112055,7 +114013,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -112068,19 +114026,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-reopen": { + "repository-vulnerability-alert-create": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -112147,7 +114107,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -112168,11 +114128,11 @@ } } }, - "repository-vulnerability-alert-resolve": { + "repository-vulnerability-alert-dismiss": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -112239,7 +114199,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -112260,13 +114220,13 @@ } } }, - "secret-scanning-alert-created": { + "repository-vulnerability-alert-reopen": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -112331,7 +114291,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -112344,22 +114304,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-location-created": { + "repository-vulnerability-alert-resolve": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -112424,22 +114383,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -112451,22 +114395,20 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -112533,7 +114475,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" } } } @@ -112555,13 +114497,13 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -112626,7 +114568,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } } } } @@ -112638,8 +114595,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -112648,11 +114606,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-publicly-leaked": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -112719,7 +114677,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -112741,11 +114699,11 @@ } } }, - "secret-scanning-alert-validated": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was validated.", - "operationId": "secret-scanning-alert/validated", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -112812,7 +114770,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -112834,13 +114792,13 @@ } } }, - "secret-scanning-scan-completed": { + "secret-scanning-alert-resolved": { "post": { - "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning scan was completed.", - "operationId": "secret-scanning-scan/completed", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_scan" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -112905,7 +114863,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -112918,7 +114876,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -112927,13 +114885,13 @@ } } }, - "security-advisory-published": { + "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -112998,7 +114956,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -113011,20 +114969,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "secret-scanning-scan-completed": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning scan was completed.", + "operationId": "secret-scanning-scan/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { @@ -113089,7 +115049,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -113102,18 +115062,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_scan", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "security-advisory-published": { "post": { "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A previously published security advisory was withdrawn.", - "operationId": "security-advisory/withdrawn", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" }, @@ -113180,7 +115142,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -113200,12 +115162,13 @@ } } }, - "security-and-analysis": { + "security-advisory-updated": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "operationId": "security-and-analysis", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -113270,7 +115233,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -113283,22 +115246,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "security_advisory", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "sponsorship-cancelled": { + "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/cancelled", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -113363,7 +115324,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -113376,20 +115337,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_advisory", "supported-webhook-types": [ - "sponsors_listing" + "app" ] } } }, - "sponsorship-created": { + "security-and-analysis": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", - "operationId": "sponsorship/created", + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "operationId": "security-and-analysis", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -113454,7 +115414,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -113467,18 +115427,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_and_analysis", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "sponsorship-edited": { + "sponsorship-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", - "operationId": "sponsorship/edited", + "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -113545,7 +115507,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -113565,11 +115527,11 @@ } } }, - "sponsorship-pending-cancellation": { + "sponsorship-created": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/pending-cancellation", + "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", + "operationId": "sponsorship/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -113636,7 +115598,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -113656,11 +115618,11 @@ } } }, - "sponsorship-pending-tier-change": { + "sponsorship-edited": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", - "operationId": "sponsorship/pending-tier-change", + "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", + "operationId": "sponsorship/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -113727,7 +115689,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -113747,11 +115709,11 @@ } } }, - "sponsorship-tier-changed": { + "sponsorship-pending-cancellation": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", - "operationId": "sponsorship/tier-changed", + "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/pending-cancellation", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -113818,7 +115780,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -113838,13 +115800,13 @@ } } }, - "star-created": { + "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone starred a repository.", - "operationId": "star/created", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", + "operationId": "sponsorship/pending-tier-change", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -113909,7 +115871,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -113922,22 +115884,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "star-deleted": { + "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone unstarred the repository.", - "operationId": "star/deleted", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", + "operationId": "sponsorship/tier-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -114002,7 +115962,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -114015,21 +115975,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "status": { + "star-created": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", - "operationId": "status", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone starred a repository.", + "operationId": "star/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -114094,7 +116053,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -114107,7 +116066,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -114116,13 +116075,13 @@ } } }, - "sub-issues-parent-issue-added": { + "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\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": "A parent issue was added to an issue.", - "operationId": "sub-issues/parent-issue-added", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone unstarred the repository.", + "operationId": "star/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -114187,7 +116146,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -114200,7 +116159,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -114209,13 +116168,12 @@ } } }, - "sub-issues-parent-issue-removed": { + "status": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\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": "A parent issue was removed from an issue.", - "operationId": "sub-issues/parent-issue-removed", + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "operationId": "status", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -114280,7 +116238,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" } } } @@ -114293,7 +116251,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -114302,11 +116260,11 @@ } } }, - "sub-issues-sub-issue-added": { + "sub-issues-parent-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\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": "A sub-issue was added to an issue.", - "operationId": "sub-issues/sub-issue-added", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" }, @@ -114373,7 +116331,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -114395,11 +116353,11 @@ } } }, - "sub-issues-sub-issue-removed": { + "sub-issues-parent-issue-removed": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\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": "A sub-issue was removed from an issue.", - "operationId": "sub-issues/sub-issue-removed", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" }, @@ -114466,7 +116424,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -114488,12 +116446,13 @@ } } }, - "team-add": { + "sub-issues-sub-issue-added": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "operationId": "team-add", + "summary": "This event occurs when there is activity relating to sub-issues.\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": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -114558,7 +116517,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -114571,7 +116530,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -114580,13 +116539,13 @@ } } }, - "team-added-to-repository": { + "sub-issues-sub-issue-removed": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was granted access to a repository.", - "operationId": "team/added-to-repository", + "summary": "This event occurs when there is activity relating to sub-issues.\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": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -114651,7 +116610,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -114664,22 +116623,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "team-add": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was created.", - "operationId": "team/created", + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "operationId": "team-add", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -114744,7 +116702,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -114757,20 +116715,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "team_add", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-deleted": { + "team-added-to-repository": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was deleted.", - "operationId": "team/deleted", + "description": "A team was granted access to a repository.", + "operationId": "team/added-to-repository", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" }, @@ -114837,7 +116795,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -114859,11 +116817,197 @@ } } }, - "team-edited": { + "team-created": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name, description, or visibility of a team was changed.", - "operationId": "team/edited", + "description": "A team was created.", + "operationId": "team/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + }, + "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-team-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "team-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team was deleted.", + "operationId": "team/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + }, + "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-team-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "team-edited": { + "post": { + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name, description, or visibility of a team was changed.", + "operationId": "team/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" }, @@ -117660,6 +119804,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.", @@ -117858,6 +120010,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.", @@ -120205,6 +122366,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -120375,6 +122543,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -120387,6 +122559,128 @@ "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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", @@ -124212,6 +126506,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.", @@ -124776,6 +127124,264 @@ "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property.", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property.", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property." + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property.", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "examples": [ + 1296269 + ] + }, + "organization_login": { + "type": "string", + "examples": [ + "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", @@ -125293,6 +127899,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" + } + ] } ] }, @@ -127708,7 +130346,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -127716,7 +130354,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -127724,7 +130362,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -132219,7 +134857,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -132227,7 +134865,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -132235,7 +134873,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -133126,6 +135764,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.", @@ -137686,40 +140333,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", - "type": [ - "null", - "string", - "array" - ] - } - }, - "required": [ - "property_name", - "value" - ] - }, "org-repo-custom-property-values": { "title": "Organization Repository Custom Property Values", "description": "List of custom property values for a repository", @@ -159764,7 +162377,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -159772,7 +162385,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -159780,7 +162393,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -213173,6 +215786,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", @@ -308637,6 +311388,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", @@ -310165,6 +312955,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": [ { @@ -310631,6 +313440,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": [ { @@ -311227,6 +314129,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": [ { @@ -312747,24 +315683,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, @@ -312870,6 +315788,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": { @@ -313773,6 +316725,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ @@ -330082,40 +333046,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", @@ -340065,6 +342995,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.", @@ -340280,6 +343229,19 @@ "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", + "examples": [ + "2025-10-13" + ] + } + }, "dependabot-alert-comma-separated-states": { "name": "state", "in": "query", @@ -340367,29 +343329,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.", @@ -340523,6 +343462,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-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 564c1b26e..9cb7fd951 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/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 @@ -1754,6 +1756,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -1773,6 +1781,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 @@ -1803,6 +1816,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 @@ -2059,6 +2265,12 @@ 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 + - 'null' examples: default: value: @@ -6198,6 +6410,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 @@ -6228,8 +6602,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': @@ -6602,6 +6974,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 @@ -7230,7 +7934,7 @@ paths: '503': "$ref": "#/components/responses/service_unavailable" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning @@ -7447,6 +8151,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" @@ -7854,8 +8559,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 @@ -8124,6 +8831,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: type: - string @@ -8371,6 +9090,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 @@ -8446,6 +9368,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: type: - string @@ -10894,12 +11828,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 @@ -11466,6 +12495,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -11483,6 +12518,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 @@ -11514,6 +12554,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 @@ -11770,6 +13001,12 @@ 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 + - 'null' examples: default: value: @@ -15079,6 +16316,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 @@ -15552,7 +16836,9 @@ paths: format: uri code_scanning_alerts: description: The code scanning alerts to include in this campaign - type: array + type: + - array + - 'null' minItems: 1 items: type: object @@ -15579,7 +16865,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -18430,8 +19720,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': @@ -23583,17 +24871,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 - examples: - - 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" @@ -23705,17 +24995,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -40287,14 +41579,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)." @@ -40305,8 +41589,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 @@ -52972,6 +54254,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 @@ -64139,17 +65424,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -64257,17 +65544,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -64631,7 +65920,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 @@ -73979,6 +75271,248 @@ 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: + "$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 + 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-deleted" + 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: + "$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: 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: + "$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: true + category: webhooks + subcategory: organization-custom-property-values + supported-webhook-types: + - business + - organization + - app organization-deleted: post: summary: |- @@ -84649,6 +86183,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 @@ -84825,6 +86366,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 @@ -86618,6 +88167,11 @@ components: - github - partner - custom + version: + description: The image version of the hosted runner pool. + type: string + examples: + - latest required: - id - size_gb @@ -86742,6 +88296,9 @@ components: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -86750,6 +88307,97 @@ 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 + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + examples: + - 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 + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - 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 @@ -89717,6 +91365,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. @@ -90159,6 +91852,189 @@ 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 + examples: + - organization + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - enterprise_actors + - enterprise_and_org_actors + - + description: Who can edit the values of the property + examples: + - enterprise_actors + 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 + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property. + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property. + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property. + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - enterprise_actors + - enterprise_and_org_actors + - + description: Who can edit the values of the property. + examples: + - enterprise_actors + 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 + type: + - 'null' + - string + - array + 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 + examples: + - 1296269 + organization_login: + type: string + examples: + - 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 @@ -90548,6 +92424,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. @@ -92298,19 +94189,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 @@ -95537,19 +97428,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 @@ -96243,6 +98134,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. @@ -99662,28 +101560,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 - type: - - 'null' - - string - - array - required: - - property_name - - value org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository @@ -115376,19 +117252,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 @@ -154683,6 +156559,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 @@ -226665,6 +228637,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 @@ -227852,6 +229852,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 @@ -228215,6 +230228,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 @@ -228675,6 +230747,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' @@ -230050,20 +232150,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 @@ -230159,6 +232245,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: @@ -230925,6 +233028,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: @@ -244859,23 +246968,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 @@ -253527,6 +255619,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. @@ -253720,6 +255827,16 @@ 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 + examples: + - '2025-10-13' dependabot-alert-comma-separated-states: name: state in: query @@ -253805,31 +255922,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. @@ -253949,6 +256041,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-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 13d5fb5fa..f1507aa50 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/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." @@ -2509,6 +2513,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -2529,6 +2540,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": [ @@ -2580,6 +2596,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", @@ -2946,6 +3237,13 @@ "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", + "null" + ] } } }, @@ -8689,6 +8987,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", @@ -8738,12 +9246,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -9284,6 +9786,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", @@ -10233,7 +11170,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "secret-scanning", "subcategory": "secret-scanning" @@ -10540,6 +11477,9 @@ "parameters": [ { "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/cost-center-state" } ], "responses": { @@ -11133,7 +12073,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" ], @@ -11501,6 +12441,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": { "type": [ "string", @@ -11902,6 +12852,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", @@ -12003,6 +13283,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": { "type": [ "string", @@ -15459,10 +16749,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" ], @@ -16119,6 +17524,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": [ + "string", + "null" + ] } } }, @@ -16137,6 +17549,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": [ @@ -16189,17 +17606,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/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization" }, "parameters": [ { @@ -16224,14 +17641,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" } } } @@ -16246,17 +17663,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/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + "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", + "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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -16555,6 +18247,13 @@ "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", + "null" + ] } } }, @@ -21105,6 +22804,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", @@ -21785,7 +23555,10 @@ }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", - "type": "array", + "type": [ + "array", + "null" + ], "minItems": 1, "items": { "type": "object", @@ -21819,8 +23592,19 @@ "required": [ "name", "description", - "ends_at", - "code_scanning_alerts" + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } ] }, "examples": { @@ -25584,12 +27368,6 @@ { "$ref": "#/components/parameters/pagination-after" }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" - }, { "$ref": "#/components/parameters/per-page" } @@ -32816,17 +34594,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } }, @@ -33004,17 +34786,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -55708,16 +57494,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).\"", @@ -55733,12 +57509,6 @@ }, { "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/pagination-first" - }, - { - "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -73421,7 +75191,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" ], @@ -88970,17 +90740,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -89149,17 +90923,21 @@ }, { "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" - }, - "examples": [ - "fields[]=123,fields[]=456,fields[]=789" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } ] } } @@ -89708,7 +91486,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" ], @@ -102779,13 +104557,13 @@ } } }, - "organization-deleted": { + "organization-custom-property-created": { "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.", - "description": "An organization was deleted.", - "operationId": "organization/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#organization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -102850,7 +104628,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-organization-custom-property-created" } } } @@ -102861,24 +104639,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "organization", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "organization", - "business", - "app" + "business" ] } } }, - "organization-member-added": { + "organization-custom-property-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.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "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" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -102943,7 +104719,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-organization-custom-property-deleted" } } } @@ -102954,24 +104730,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "organization", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "organization", - "business", - "app" + "business" ] } } }, - "organization-member-invited": { + "organization-custom-property-updated": { "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.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "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" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -103036,7 +104810,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-organization-custom-property-updated" } } } @@ -103047,24 +104821,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "organization", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "organization", - "business", - "app" + "business" ] } } }, - "organization-member-removed": { + "organization-custom-property-values-updated": { "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.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "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" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values" }, "parameters": [ { @@ -103129,7 +104901,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-organization-custom-property-values-updated" } } } @@ -103140,22 +104912,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "organization", + "subcategory": "organization-custom-property-values", "supported-webhook-types": [ - "organization", "business", + "organization", "app" ] } } }, - "organization-renamed": { + "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.", - "description": "The name of an organization was changed.", - "operationId": "organization/renamed", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, @@ -103222,7 +104994,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -103244,13 +105016,13 @@ } } }, - "package-published": { + "organization-member-added": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "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.", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -103315,7 +105087,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -103328,22 +105100,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "package-updated": { + "organization-member-invited": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "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.", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -103408,7 +105180,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -103421,21 +105193,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "page-build": { + "organization-member-removed": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "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.", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -103500,7 +105273,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -103513,22 +105286,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page_build", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "personal-access-token-request-approved": { + "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was approved.", - "operationId": "personal-access-token-request/approved", + "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.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -103540,9 +105313,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -103550,31 +105323,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", + "example": "issues", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Id", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": 12312312, + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": 123123, + "example": "repository", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Delivery", "in": "header", - "example": "integration", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -103593,7 +105366,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -103606,21 +105379,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "organization", "supported-webhook-types": [ - "app", - "organization" + "organization", + "business", + "app" ] } } }, - "personal-access-token-request-cancelled": { + "package-published": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was cancelled by the requester.", - "operationId": "personal-access-token-request/cancelled", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -103632,9 +105406,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -103642,31 +105416,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", + "example": "issues", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Id", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": 12312312, + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": 123123, + "example": "repository", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Delivery", "in": "header", - "example": "integration", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -103685,7 +105459,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -103698,21 +105472,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "package", "supported-webhook-types": [ - "app", - "organization" + "repository", + "organization", + "app" ] } } }, - "personal-access-token-request-created": { + "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was created.", - "operationId": "personal-access-token-request/created", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -103723,6 +105498,38 @@ "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", @@ -103732,9 +105539,53 @@ } }, { - "name": "X-Github-Event", + "name": "X-Hub-Signature-256", "in": "header", - "example": "personal_access_token_request", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-package-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "package", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "page-build": { + "post": { + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" } @@ -103747,6 +105598,14 @@ "type": "string" } }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", @@ -103758,7 +105617,15 @@ { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "integration", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -103777,7 +105644,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -103790,19 +105657,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "page_build", "supported-webhook-types": [ - "app", - "organization" + "repository", + "organization", + "app" ] } } }, - "personal-access-token-request-denied": { + "personal-access-token-request-approved": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was denied.", - "operationId": "personal-access-token-request/denied", + "description": "A fine-grained personal access token request was approved.", + "operationId": "personal-access-token-request/approved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -103869,7 +105737,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" } } } @@ -103890,12 +105758,13 @@ } } }, - "ping": { + "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", - "operationId": "ping", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was cancelled by the requester.", + "operationId": "personal-access-token-request/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -103907,9 +105776,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -103917,31 +105786,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -103960,22 +105829,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-ping" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-ping-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping-form-encoded" - } + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -103987,26 +105841,22 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app", - "business", - "marketplace" + "organization" ] } } }, - "project-card-converted": { + "personal-access-token-request-created": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a project (classic) was converted to an issue.", - "operationId": "project-card/converted", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -104017,38 +105867,6 @@ "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", @@ -104058,54 +105876,9 @@ } }, { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-project-card-converted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "project_card", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "project-card-created": { - "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card was added to a project (classic).", - "operationId": "project-card/created", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" - }, - "parameters": [ - { - "name": "User-Agent", + "name": "X-Github-Event", "in": "header", - "example": "GitHub-Hookshot/123abc", + "example": "personal_access_token_request", "schema": { "type": "string" } @@ -104118,14 +105891,6 @@ "type": "string" } }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", @@ -104137,15 +105902,7 @@ { "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", + "example": "integration", "schema": { "type": "string" } @@ -104164,7 +105921,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } @@ -104177,22 +105934,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", - "app" + "app", + "organization" ] } } }, - "project-card-deleted": { + "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was deleted.", - "operationId": "project-card/deleted", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -104204,9 +105960,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -104214,31 +105970,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -104257,7 +106013,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -104270,22 +106026,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", - "app" + "app", + "organization" ] } } }, - "project-card-edited": { + "ping": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note on a project (classic) was edited.", - "operationId": "project-card/edited", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -104350,7 +106104,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-ping" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-ping-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping-form-encoded" + } } } } @@ -104362,21 +106131,24 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "ping", "supported-webhook-types": [ "repository", "organization", - "app" + "app", + "business", + "marketplace" ] } } }, - "project-card-moved": { + "project-card-converted": { "post": { "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was moved to another column or to another position in its column.", - "operationId": "project-card/moved", + "description": "A note in a project (classic) was converted to an issue.", + "operationId": "project-card/converted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, @@ -104443,7 +106215,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-project-card-converted" } } } @@ -104465,13 +106237,13 @@ } } }, - "project-closed": { + "project-card-created": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/closed", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card was added to a project (classic).", + "operationId": "project-card/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -104536,7 +106308,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-project-card-created" } } } @@ -104549,7 +106321,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -104558,13 +106330,13 @@ } } }, - "project-column-created": { + "project-card-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was added to a project (classic).", - "operationId": "project-column/created", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was deleted.", + "operationId": "project-card/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -104629,7 +106401,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-project-card-deleted" } } } @@ -104642,7 +106414,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -104651,13 +106423,13 @@ } } }, - "project-column-deleted": { + "project-card-edited": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was deleted from a project (classic).", - "operationId": "project-column/deleted", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note on a project (classic) was edited.", + "operationId": "project-card/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -104722,7 +106494,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-card-edited" } } } @@ -104735,7 +106507,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -104744,13 +106516,13 @@ } } }, - "project-column-edited": { + "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name of a column on a project (classic) was changed.", - "operationId": "project-column/edited", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was moved to another column or to another position in its column.", + "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -104815,7 +106587,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-card-moved" } } } @@ -104828,7 +106600,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -104837,13 +106609,13 @@ } } }, - "project-column-moved": { + "project-closed": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was moved to a new position on a project (classic).", - "operationId": "project-column/moved", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -104908,7 +106680,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-closed" } } } @@ -104921,7 +106693,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -104930,13 +106702,13 @@ } } }, - "project-created": { + "project-column-created": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was created.", - "operationId": "project/created", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was added to a project (classic).", + "operationId": "project-column/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -105001,7 +106773,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-column-created" } } } @@ -105014,7 +106786,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -105023,13 +106795,13 @@ } } }, - "project-deleted": { + "project-column-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was deleted.", - "operationId": "project/deleted", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was deleted from a project (classic).", + "operationId": "project-column/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -105094,7 +106866,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-column-deleted" } } } @@ -105107,7 +106879,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -105116,13 +106888,13 @@ } } }, - "project-edited": { + "project-column-edited": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name or description of a project (classic) was changed.", - "operationId": "project/edited", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name of a column on a project (classic) was changed.", + "operationId": "project-column/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -105187,7 +106959,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-project-column-edited" } } } @@ -105200,7 +106972,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -105209,13 +106981,13 @@ } } }, - "project-reopened": { + "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/reopened", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was moved to a new position on a project (classic).", + "operationId": "project-column/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -105280,7 +107052,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-project-column-moved" } } } @@ -105293,7 +107065,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -105302,13 +107074,13 @@ } } }, - "projects-v2-closed": { + "project-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was closed.", - "operationId": "projects-v2/closed", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was created.", + "operationId": "project/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -105330,7 +107102,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -105373,7 +107145,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-project-created" } } } @@ -105385,22 +107157,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-created": { + "project-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was created.", - "operationId": "projects-v2/created", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was deleted.", + "operationId": "project/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -105422,7 +107195,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -105465,7 +107238,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-project-deleted" } } } @@ -105477,22 +107250,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-deleted": { + "project-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was deleted.", - "operationId": "projects-v2/deleted", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name or description of a project (classic) was changed.", + "operationId": "project/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -105514,7 +107288,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -105557,7 +107331,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-project-edited" } } } @@ -105569,22 +107343,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-edited": { + "project-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The title, description, or README of a project in the organization was changed.", - "operationId": "projects-v2/edited", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -105606,7 +107381,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -105649,7 +107424,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-project-reopened" } } } @@ -105661,22 +107436,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-archived": { + "projects-v2-closed": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was closed.", + "operationId": "projects-v2/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -105698,7 +107474,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -105741,7 +107517,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" } } } @@ -105755,20 +107531,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-converted": { + "projects-v2-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A draft issue in an organization project was converted to an issue.", - "operationId": "projects-v2-item/converted", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was created.", + "operationId": "projects-v2/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -105790,7 +107566,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -105833,7 +107609,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" } } } @@ -105847,20 +107623,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-created": { + "projects-v2-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was added to a project in the organization.", - "operationId": "projects-v2-item/created", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was deleted.", + "operationId": "projects-v2/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -105882,7 +107658,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -105925,7 +107701,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" } } } @@ -105939,20 +107715,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-deleted": { + "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was deleted from a project in the organization.", - "operationId": "projects-v2-item/deleted", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The title, description, or README of a project in the organization was changed.", + "operationId": "projects-v2/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -105974,7 +107750,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -106017,7 +107793,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" } } } @@ -106031,18 +107807,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-edited": { + "projects-v2-item-archived": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", - "operationId": "projects-v2-item/edited", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/archived", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -106109,7 +107885,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" } } } @@ -106130,11 +107906,11 @@ } } }, - "projects-v2-item-reordered": { + "projects-v2-item-converted": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", - "operationId": "projects-v2-item/reordered", + "description": "A draft issue in an organization project was converted to an issue.", + "operationId": "projects-v2-item/converted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -106201,7 +107977,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" } } } @@ -106222,11 +107998,11 @@ } } }, - "projects-v2-item-restored": { + "projects-v2-item-created": { "post": { "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -106293,7 +108069,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" } } } @@ -106314,13 +108090,13 @@ } } }, - "projects-v2-reopened": { + "projects-v2-item-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was reopened.", - "operationId": "projects-v2/reopened", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -106342,7 +108118,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -106385,7 +108161,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" } } } @@ -106399,20 +108175,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-status-update-created": { + "projects-v2-item-edited": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was added to a project in the organization.", - "operationId": "projects-v2-status-update/created", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", + "operationId": "projects-v2-item/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -106434,7 +108210,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "project-v2-item", "schema": { "type": "string" } @@ -106477,7 +108253,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" } } } @@ -106491,20 +108267,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-status-update-deleted": { + "projects-v2-item-reordered": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was removed from a project in the organization.", - "operationId": "projects-v2-status-update/deleted", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", + "operationId": "projects-v2-item/reordered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -106526,7 +108302,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "project-v2-item", "schema": { "type": "string" } @@ -106569,7 +108345,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" } } } @@ -106583,20 +108359,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-status-update-edited": { + "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was edited on a project in the organization.", - "operationId": "projects-v2-status-update/edited", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/restored", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -106618,7 +108394,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "project-v2-item", "schema": { "type": "string" } @@ -106661,7 +108437,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" } } } @@ -106675,19 +108451,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "public": { + "projects-v2-reopened": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "operationId": "public", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was reopened.", + "operationId": "projects-v2/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -106709,7 +108486,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -106752,7 +108529,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" } } } @@ -106764,23 +108541,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "public", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-assigned": { + "projects-v2-status-update-created": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was assigned to a user.", - "operationId": "pull-request/assigned", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was added to a project in the organization.", + "operationId": "projects-v2-status-update/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -106802,7 +108578,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -106845,7 +108621,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" } } } @@ -106857,23 +108633,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-auto-merge-disabled": { + "projects-v2-status-update-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was removed from a project in the organization.", + "operationId": "projects-v2-status-update/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -106895,7 +108670,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -106938,7 +108713,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" } } } @@ -106950,23 +108725,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-auto-merge-enabled": { + "projects-v2-status-update-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was edited on a project in the organization.", + "operationId": "projects-v2-status-update/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -106988,7 +108762,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -107031,7 +108805,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" } } } @@ -107043,23 +108817,21 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-closed": { + "public": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", - "operationId": "pull-request/closed", + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -107124,7 +108896,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-public" } } } @@ -107137,7 +108909,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "public", "supported-webhook-types": [ "repository", "organization", @@ -107146,11 +108918,11 @@ } } }, - "pull-request-converted-to-draft": { + "pull-request-assigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/converted-to-draft", + "description": "A pull request was assigned to a user.", + "operationId": "pull-request/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107217,7 +108989,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-pull-request-assigned" } } } @@ -107239,11 +109011,11 @@ } } }, - "pull-request-demilestoned": { + "pull-request-auto-merge-disabled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from a milestone.", - "operationId": "pull-request/demilestoned", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-disabled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107310,7 +109082,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" } } } @@ -107332,11 +109104,11 @@ } } }, - "pull-request-dequeued": { + "pull-request-auto-merge-enabled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from the merge queue.", - "operationId": "pull-request/dequeued", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-enabled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107403,7 +109175,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" } } } @@ -107425,11 +109197,11 @@ } } }, - "pull-request-edited": { + "pull-request-closed": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", - "operationId": "pull-request/edited", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107496,7 +109268,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-closed" } } } @@ -107518,11 +109290,11 @@ } } }, - "pull-request-enqueued": { + "pull-request-converted-to-draft": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to the merge queue.", - "operationId": "pull-request/enqueued", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107589,7 +109361,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" } } } @@ -107611,11 +109383,11 @@ } } }, - "pull-request-labeled": { + "pull-request-demilestoned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was added to a pull request.", - "operationId": "pull-request/labeled", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107682,7 +109454,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" } } } @@ -107704,11 +109476,11 @@ } } }, - "pull-request-locked": { + "pull-request-dequeued": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/locked", + "description": "A pull request was removed from the merge queue.", + "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107775,7 +109547,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" } } } @@ -107797,11 +109569,11 @@ } } }, - "pull-request-milestoned": { + "pull-request-edited": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to a milestone.", - "operationId": "pull-request/milestoned", + "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", + "operationId": "pull-request/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107868,7 +109640,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-edited" } } } @@ -107890,11 +109662,11 @@ } } }, - "pull-request-opened": { + "pull-request-enqueued": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was created", - "operationId": "pull-request/opened", + "description": "A pull request was added to the merge queue.", + "operationId": "pull-request/enqueued", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -107961,7 +109733,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" } } } @@ -107983,11 +109755,11 @@ } } }, - "pull-request-ready-for-review": { + "pull-request-labeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/ready-for-review", + "description": "A label was added to a pull request.", + "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -108054,7 +109826,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-labeled" } } } @@ -108076,11 +109848,11 @@ } } }, - "pull-request-reopened": { + "pull-request-locked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously closed pull request was reopened.", - "operationId": "pull-request/reopened", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -108147,7 +109919,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-locked" } } } @@ -108169,13 +109941,13 @@ } } }, - "pull-request-review-comment-created": { + "pull-request-milestoned": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was created.", - "operationId": "pull-request-review-comment/created", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a milestone.", + "operationId": "pull-request/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -108240,7 +110012,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" } } } @@ -108253,7 +110025,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -108262,13 +110034,13 @@ } } }, - "pull-request-review-comment-deleted": { + "pull-request-opened": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was deleted.", - "operationId": "pull-request-review-comment/deleted", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", + "operationId": "pull-request/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -108333,7 +110105,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-opened" } } } @@ -108346,7 +110118,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -108355,13 +110127,13 @@ } } }, - "pull-request-review-comment-edited": { + "pull-request-ready-for-review": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The content of a comment on a pull request diff was changed.", - "operationId": "pull-request-review-comment/edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/ready-for-review", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -108426,7 +110198,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" } } } @@ -108439,7 +110211,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -108448,13 +110220,13 @@ } } }, - "pull-request-review-dismissed": { + "pull-request-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was dismissed.", - "operationId": "pull-request-review/dismissed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", + "operationId": "pull-request/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -108519,7 +110291,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-reopened" } } } @@ -108532,7 +110304,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -108541,13 +110313,13 @@ } } }, - "pull-request-review-edited": { + "pull-request-review-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The body comment on a pull request review was edited.", - "operationId": "pull-request-review/edited", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", + "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -108612,7 +110384,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" } } } @@ -108625,7 +110397,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -108634,13 +110406,13 @@ } } }, - "pull-request-review-request-removed": { + "pull-request-review-comment-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A request for review by a person or team was removed from a pull request.", - "operationId": "pull-request/review-request-removed", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", + "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -108705,7 +110477,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" } } } @@ -108718,7 +110490,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -108727,13 +110499,13 @@ } } }, - "pull-request-review-requested": { + "pull-request-review-comment-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", - "operationId": "pull-request/review-requested", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, 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#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", + "operationId": "pull-request-review-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -108798,7 +110570,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" } } } @@ -108811,7 +110583,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -108820,11 +110592,11 @@ } } }, - "pull-request-review-submitted": { + "pull-request-review-dismissed": { "post": { "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was submitted.", - "operationId": "pull-request-review/submitted", + "description": "A review on a pull request was dismissed.", + "operationId": "pull-request-review/dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" }, @@ -108891,7 +110663,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" } } } @@ -108913,106 +110685,13 @@ } } }, - "pull-request-review-thread-resolved": { - "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment thread on a pull request was marked as resolved.", - "operationId": "pull-request-review-thread/resolved", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" - }, - "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-pull-request-review-thread-resolved" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "pull_request_review_thread", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-review-thread-unresolved": { + "pull-request-review-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously resolved comment thread on a pull request was marked as unresolved.", - "operationId": "pull-request-review-thread/unresolved", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", + "operationId": "pull-request-review/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -109077,7 +110756,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" } } } @@ -109090,7 +110769,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -109099,11 +110778,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-review-request-removed": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A request for review by a person or team was removed from a pull request.", + "operationId": "pull-request/review-request-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109170,7 +110849,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" } } } @@ -109192,11 +110871,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-review-requested": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "operationId": "pull-request/review-requested", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109263,7 +110942,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" } } } @@ -109285,13 +110964,13 @@ } } }, - "pull-request-unlabeled": { + "pull-request-review-submitted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -109356,7 +111035,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" } } } @@ -109369,7 +111048,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -109378,11 +111057,197 @@ } } }, - "pull-request-unlocked": { + "pull-request-review-thread-resolved": { + "post": { + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", + "operationId": "pull-request-review-thread/resolved", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + }, + "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-pull-request-review-thread-resolved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review_thread", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-thread-unresolved": { + "post": { + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", + "operationId": "pull-request-review-thread/unresolved", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + }, + "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-pull-request-review-thread-unresolved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review_thread", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109449,7 +111314,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -109471,12 +111336,13 @@ } } }, - "push": { + "pull-request-unassigned": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -109541,7 +111407,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -109554,7 +111420,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -109563,13 +111429,13 @@ } } }, - "registry-package-published": { + "pull-request-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -109634,7 +111500,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -109647,7 +111513,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -109656,13 +111522,13 @@ } } }, - "registry-package-updated": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[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 pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -109727,7 +111593,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -109740,7 +111606,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -109749,13 +111615,12 @@ } } }, - "release-created": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) 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> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -109820,7 +111685,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-push" } } } @@ -109833,7 +111698,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -109842,13 +111707,13 @@ } } }, - "release-deleted": { + "registry-package-published": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -109913,7 +111778,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -109926,7 +111791,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -109935,11 +111800,104 @@ } } }, - "release-edited": { + "registry-package-updated": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + }, + "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-registry-package-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "registry_package", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-created": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -110006,7 +111964,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -110028,11 +111986,11 @@ } } }, - "release-prereleased": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -110099,7 +112057,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -110121,11 +112079,11 @@ } } }, - "release-published": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -110192,7 +112150,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -110214,11 +112172,11 @@ } } }, - "release-released": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -110285,7 +112243,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -110307,11 +112265,11 @@ } } }, - "release-unpublished": { + "release-published": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -110378,7 +112336,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -110400,13 +112358,13 @@ } } }, - "repository-advisory-published": { + "release-released": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -110471,7 +112429,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -110484,7 +112442,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -110493,13 +112451,13 @@ } } }, - "repository-advisory-reported": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A private vulnerability report was submitted.", - "operationId": "repository-advisory/reported", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" 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.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -110564,7 +112522,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -110577,7 +112535,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -110586,13 +112544,13 @@ } } }, - "repository-archived": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was archived.", - "operationId": "repository/archived", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -110657,7 +112615,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -110670,9 +112628,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -110680,13 +112637,13 @@ } } }, - "repository-created": { + "repository-advisory-reported": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was created.", - "operationId": "repository/created", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -110751,7 +112708,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -110764,9 +112721,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -110774,11 +112730,11 @@ } } }, - "repository-deleted": { + "repository-archived": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", - "operationId": "repository/deleted", + "description": "A repository was archived.", + "operationId": "repository/archived", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -110845,7 +112801,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -110868,12 +112824,13 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-created": { "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -110938,7 +112895,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -110951,18 +112908,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "repository-deleted": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The topics, default branch, description, or homepage of a repository was changed.", - "operationId": "repository/edited", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -111029,7 +112989,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -111052,12 +113012,12 @@ } } }, - "repository-import": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports).", - "operationId": "repository-import", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -111122,7 +113082,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -111135,19 +113095,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "repository", - "organization" + "app" ] } } }, - "repository-privatized": { + "repository-edited": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -111214,7 +113173,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -111237,13 +113196,12 @@ } } }, - "repository-publicized": { + "repository-import": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -111308,7 +113266,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -111321,21 +113279,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_import", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-renamed": { + "repository-privatized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -111402,7 +113358,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -111425,13 +113381,13 @@ } } }, - "repository-ruleset-created": { + "repository-publicized": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -111496,7 +113452,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -111509,8 +113465,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -111518,13 +113475,13 @@ } } }, - "repository-ruleset-deleted": { + "repository-renamed": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -111589,7 +113546,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -111602,8 +113559,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -111611,11 +113569,11 @@ } } }, - "repository-ruleset-edited": { + "repository-ruleset-created": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -111682,7 +113640,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -111704,13 +113662,13 @@ } } }, - "repository-transferred": { + "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -111775,7 +113733,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -111788,9 +113746,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -111798,13 +113755,13 @@ } } }, - "repository-unarchived": { + "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -111869,7 +113826,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -111882,9 +113839,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -111892,13 +113848,13 @@ } } }, - "repository-vulnerability-alert-create": { + "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -111963,7 +113919,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -111976,21 +113932,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-dismiss": { + "repository-unarchived": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -112055,7 +114013,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -112068,19 +114026,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-reopen": { + "repository-vulnerability-alert-create": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -112147,7 +114107,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -112168,11 +114128,11 @@ } } }, - "repository-vulnerability-alert-resolve": { + "repository-vulnerability-alert-dismiss": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -112239,7 +114199,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -112260,13 +114220,13 @@ } } }, - "secret-scanning-alert-created": { + "repository-vulnerability-alert-reopen": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -112331,7 +114291,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -112344,22 +114304,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-location-created": { + "repository-vulnerability-alert-resolve": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -112424,22 +114383,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -112451,22 +114395,20 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -112533,7 +114475,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" } } } @@ -112555,13 +114497,13 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -112626,7 +114568,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } } } } @@ -112638,8 +114595,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -112648,11 +114606,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-publicly-leaked": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -112719,7 +114677,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -112741,11 +114699,11 @@ } } }, - "secret-scanning-alert-validated": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was validated.", - "operationId": "secret-scanning-alert/validated", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -112812,7 +114770,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -112834,13 +114792,13 @@ } } }, - "secret-scanning-scan-completed": { + "secret-scanning-alert-resolved": { "post": { - "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning scan was completed.", - "operationId": "secret-scanning-scan/completed", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_scan" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -112905,7 +114863,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -112918,7 +114876,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_scan", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -112927,13 +114885,13 @@ } } }, - "security-advisory-published": { + "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -112998,7 +114956,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -113011,20 +114969,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "secret-scanning-scan-completed": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning scan was completed.", + "operationId": "secret-scanning-scan/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { @@ -113089,7 +115049,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -113102,18 +115062,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_scan", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "security-advisory-published": { "post": { "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A previously published security advisory was withdrawn.", - "operationId": "security-advisory/withdrawn", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" }, @@ -113180,7 +115142,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -113200,12 +115162,13 @@ } } }, - "security-and-analysis": { + "security-advisory-updated": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "operationId": "security-and-analysis", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -113270,7 +115233,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -113283,22 +115246,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "security_advisory", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "sponsorship-cancelled": { + "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/cancelled", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -113363,7 +115324,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -113376,20 +115337,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_advisory", "supported-webhook-types": [ - "sponsors_listing" + "app" ] } } }, - "sponsorship-created": { + "security-and-analysis": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", - "operationId": "sponsorship/created", + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "operationId": "security-and-analysis", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -113454,7 +115414,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -113467,18 +115427,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_and_analysis", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "sponsorship-edited": { + "sponsorship-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", - "operationId": "sponsorship/edited", + "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -113545,7 +115507,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -113565,11 +115527,11 @@ } } }, - "sponsorship-pending-cancellation": { + "sponsorship-created": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/pending-cancellation", + "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", + "operationId": "sponsorship/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -113636,7 +115598,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -113656,11 +115618,11 @@ } } }, - "sponsorship-pending-tier-change": { + "sponsorship-edited": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", - "operationId": "sponsorship/pending-tier-change", + "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", + "operationId": "sponsorship/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -113727,7 +115689,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -113747,11 +115709,11 @@ } } }, - "sponsorship-tier-changed": { + "sponsorship-pending-cancellation": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", - "operationId": "sponsorship/tier-changed", + "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/pending-cancellation", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -113818,7 +115780,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -113838,13 +115800,13 @@ } } }, - "star-created": { + "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone starred a repository.", - "operationId": "star/created", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", + "operationId": "sponsorship/pending-tier-change", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -113909,7 +115871,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -113922,22 +115884,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "star-deleted": { + "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone unstarred the repository.", - "operationId": "star/deleted", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", + "operationId": "sponsorship/tier-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -114002,7 +115962,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -114015,21 +115975,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "status": { + "star-created": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", - "operationId": "status", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone starred a repository.", + "operationId": "star/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -114094,7 +116053,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -114107,7 +116066,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -114116,13 +116075,13 @@ } } }, - "sub-issues-parent-issue-added": { + "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\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": "A parent issue was added to an issue.", - "operationId": "sub-issues/parent-issue-added", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone unstarred the repository.", + "operationId": "star/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -114187,7 +116146,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -114200,7 +116159,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -114209,13 +116168,12 @@ } } }, - "sub-issues-parent-issue-removed": { + "status": { "post": { - "summary": "This event occurs when there is activity relating to sub-issues.\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": "A parent issue was removed from an issue.", - "operationId": "sub-issues/parent-issue-removed", + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "operationId": "status", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -114280,7 +116238,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-status" } } } @@ -114293,7 +116251,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sub-issues", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -114302,11 +116260,11 @@ } } }, - "sub-issues-sub-issue-added": { + "sub-issues-parent-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\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": "A sub-issue was added to an issue.", - "operationId": "sub-issues/sub-issue-added", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" }, @@ -114373,7 +116331,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -114395,11 +116353,11 @@ } } }, - "sub-issues-sub-issue-removed": { + "sub-issues-parent-issue-removed": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\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": "A sub-issue was removed from an issue.", - "operationId": "sub-issues/sub-issue-removed", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" }, @@ -114466,7 +116424,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -114488,12 +116446,13 @@ } } }, - "team-add": { + "sub-issues-sub-issue-added": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "operationId": "team-add", + "summary": "This event occurs when there is activity relating to sub-issues.\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": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -114558,7 +116517,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -114571,7 +116530,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "sub-issues", "supported-webhook-types": [ "repository", "organization", @@ -114580,13 +116539,13 @@ } } }, - "team-added-to-repository": { + "sub-issues-sub-issue-removed": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was granted access to a repository.", - "operationId": "team/added-to-repository", + "summary": "This event occurs when there is activity relating to sub-issues.\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": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -114651,7 +116610,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -114664,22 +116623,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "team-add": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was created.", - "operationId": "team/created", + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "operationId": "team-add", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -114744,7 +116702,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -114757,20 +116715,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "team_add", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-deleted": { + "team-added-to-repository": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was deleted.", - "operationId": "team/deleted", + "description": "A team was granted access to a repository.", + "operationId": "team/added-to-repository", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" }, @@ -114837,7 +116795,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -114859,11 +116817,197 @@ } } }, - "team-edited": { + "team-created": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name, description, or visibility of a team was changed.", - "operationId": "team/edited", + "description": "A team was created.", + "operationId": "team/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + }, + "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-team-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "team-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team was deleted.", + "operationId": "team/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + }, + "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-team-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "team-edited": { + "post": { + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name, description, or visibility of a team was changed.", + "operationId": "team/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" }, @@ -117660,6 +119804,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.", @@ -117858,6 +120010,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.", @@ -120205,6 +122366,13 @@ "partner", "custom" ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "examples": [ + "latest" + ] } }, "required": [ @@ -120375,6 +122543,10 @@ "examples": [ "2022-10-09T23:39:01Z" ] + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ @@ -120387,6 +122559,128 @@ "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", + "examples": [ + 1 + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "examples": [ + 200 + ] + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + "CustomImage" + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "examples": [ + "custom" + ] + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "examples": [ + 4 + ] + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "examples": [ + "1.3.0" + ] + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "examples": [ + "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", + "examples": [ + "1.0.0" + ] + }, + "state": { + "description": "The state of image version.", + "type": "string", + "examples": [ + "Ready" + ] + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "examples": [ + 30 + ] + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "examples": [ + "2024-11-09T23:39:01Z" + ] + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "examples": [ + "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", @@ -124212,6 +126506,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.", @@ -124776,6 +127124,264 @@ "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" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property.", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property.", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property." + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "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", + "null" + ], + "enum": [ + "enterprise_actors", + "enterprise_and_org_actors", + null + ], + "description": "Who can edit the values of the property.", + "examples": [ + "enterprise_actors" + ] + } + }, + "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", + "type": [ + "null", + "string", + "array" + ] + } + }, + "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", + "examples": [ + 1296269 + ] + }, + "organization_login": { + "type": "string", + "examples": [ + "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", @@ -125293,6 +127899,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" + } + ] } ] }, @@ -127708,7 +130346,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -127716,7 +130354,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -127724,7 +130362,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -132219,7 +134857,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -132227,7 +134865,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -132235,7 +134873,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -133126,6 +135764,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.", @@ -137686,40 +140333,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", - "type": [ - "null", - "string", - "array" - ] - } - }, - "required": [ - "property_name", - "value" - ] - }, "org-repo-custom-property-values": { "title": "Organization Repository Custom Property Values", "description": "List of custom property values for a repository", @@ -159764,7 +162377,7 @@ "description": "Price per unit of the usage line item." }, "grossQuantity": { - "type": "integer", + "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { @@ -159772,7 +162385,7 @@ "description": "Gross amount of the usage line item." }, "discountQuantity": { - "type": "integer", + "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { @@ -159780,7 +162393,7 @@ "description": "Discount amount of the usage line item." }, "netQuantity": { - "type": "integer", + "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { @@ -213173,6 +215786,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", @@ -308637,6 +311388,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", @@ -310165,6 +312955,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": [ { @@ -310631,6 +313440,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": [ { @@ -311227,6 +314129,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": [ { @@ -312747,24 +315683,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, @@ -312870,6 +315788,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": { @@ -313773,6 +316725,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ @@ -330082,40 +333046,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", @@ -340065,6 +342995,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.", @@ -340280,6 +343229,19 @@ "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", + "examples": [ + "2025-10-13" + ] + } + }, "dependabot-alert-comma-separated-states": { "name": "state", "in": "query", @@ -340367,29 +343329,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.", @@ -340523,6 +343462,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-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 564c1b26e..9cb7fd951 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/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 @@ -1754,6 +1756,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -1773,6 +1781,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 @@ -1803,6 +1816,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 @@ -2059,6 +2265,12 @@ 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 + - 'null' examples: default: value: @@ -6198,6 +6410,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 @@ -6228,8 +6602,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': @@ -6602,6 +6974,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 @@ -7230,7 +7934,7 @@ paths: '503': "$ref": "#/components/responses/service_unavailable" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning @@ -7447,6 +8151,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" @@ -7854,8 +8559,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 @@ -8124,6 +8831,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: type: - string @@ -8371,6 +9090,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 @@ -8446,6 +9368,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: type: - string @@ -10894,12 +11828,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 @@ -11466,6 +12495,12 @@ 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 + - 'null' size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` @@ -11483,6 +12518,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 @@ -11514,6 +12554,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 @@ -11770,6 +13001,12 @@ 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 + - 'null' examples: default: value: @@ -15079,6 +16316,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 @@ -15552,7 +16836,9 @@ paths: format: uri code_scanning_alerts: description: The code scanning alerts to include in this campaign - type: array + type: + - array + - 'null' minItems: 1 items: type: object @@ -15579,7 +16865,11 @@ paths: - name - description - ends_at - - code_scanning_alerts + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts examples: default: value: @@ -18430,8 +19720,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': @@ -23583,17 +24871,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 - examples: - - 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" @@ -23705,17 +24995,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -40287,14 +41579,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)." @@ -40305,8 +41589,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 @@ -52972,6 +54254,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 @@ -64139,17 +65424,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -64257,17 +65544,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 - examples: - - fields[]=123,fields[]=456,fields[]=789 + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string responses: '200': description: Response @@ -64631,7 +65920,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 @@ -73979,6 +75271,248 @@ 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: + "$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 + 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-deleted" + 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: + "$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: 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: + "$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: true + category: webhooks + subcategory: organization-custom-property-values + supported-webhook-types: + - business + - organization + - app organization-deleted: post: summary: |- @@ -84649,6 +86183,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 @@ -84825,6 +86366,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 @@ -86618,6 +88167,11 @@ components: - github - partner - custom + version: + description: The image version of the hosted runner pool. + type: string + examples: + - latest required: - id - size_gb @@ -86742,6 +88296,9 @@ components: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -86750,6 +88307,97 @@ 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 + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + examples: + - 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 + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - 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 @@ -89717,6 +91365,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. @@ -90159,6 +91852,189 @@ 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 + examples: + - organization + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - enterprise_actors + - enterprise_and_org_actors + - + description: Who can edit the values of the property + examples: + - enterprise_actors + 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 + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property. + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property. + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property. + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - enterprise_actors + - enterprise_and_org_actors + - + description: Who can edit the values of the property. + examples: + - enterprise_actors + 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 + type: + - 'null' + - string + - array + 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 + examples: + - 1296269 + organization_login: + type: string + examples: + - 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 @@ -90548,6 +92424,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. @@ -92298,19 +94189,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 @@ -95537,19 +97428,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 @@ -96243,6 +98134,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. @@ -99662,28 +101560,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 - type: - - 'null' - - string - - array - required: - - property_name - - value org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository @@ -115376,19 +117252,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 @@ -154683,6 +156559,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 @@ -226665,6 +228637,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 @@ -227852,6 +229852,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 @@ -228215,6 +230228,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 @@ -228675,6 +230747,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' @@ -230050,20 +232150,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 @@ -230159,6 +232245,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: @@ -230925,6 +233028,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: @@ -244859,23 +246968,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 @@ -253527,6 +255619,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. @@ -253720,6 +255827,16 @@ 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 + examples: + - '2025-10-13' dependabot-alert-comma-separated-states: name: state in: query @@ -253805,31 +255922,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. @@ -253949,6 +256041,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-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index 88cc6afcc..66edd225e 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -43296,6 +43296,14 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", + "schema": { + "type": "string" + } + }, { "name": "has", "in": "query", @@ -46337,7 +46345,245 @@ }, "examples": { "default": { - "value": {} + "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" + }, + { + "number": 1, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", + "html_url": "https://github.com/owner/repo/security/secret-scanning/1", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret_type_display_name": "Mailchimp API Key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "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": null, + "push_protection_bypassed": false, + "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown" + } + ] } } } @@ -46400,7 +46646,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "secret-scanning", "subcategory": "secret-scanning" @@ -135595,10 +135841,34 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "artifact_registry", + "in": "query", + "description": "A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`", + "schema": { + "type": "string" + } + }, { "name": "has", "in": "query", - "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.", + "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.", "schema": { "oneOf": [ { @@ -135609,13 +135879,22 @@ "items": { "type": "string", "enum": [ - "patch" + "patch", + "deployment" ] } } ] } }, + { + "name": "runtime_risk", + "in": "query", + "description": "A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`", + "schema": { + "type": "string" + } + }, { "name": "scope", "in": "query", @@ -209390,7 +209669,245 @@ }, "examples": { "default": { - "value": {} + "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" + }, + { + "number": 1, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", + "html_url": "https://github.com/owner/repo/security/secret-scanning/1", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret_type_display_name": "Mailchimp API Key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "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": null, + "push_protection_bypassed": false, + "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown" + } + ] } } } @@ -334582,6 +335099,22 @@ "type": "string" } }, + { + "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" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", + "schema": { + "type": "string" + } + }, { "name": "has", "in": "query", @@ -334603,14 +335136,6 @@ ] } }, - { - "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" - } - }, { "name": "scope", "in": "query", @@ -334649,6 +335174,67 @@ ], "default": "desc" } + }, + { + "name": "page", + "description": "**Deprecated**. 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-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "deprecated": true, + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/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-server@3.14/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-server@3.14/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-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "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": { @@ -527196,7 +527782,111 @@ }, "examples": { "default": { - "value": {} + "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", + "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:{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}